Ensure old tab state is cleared between iterations of run-benchmark
[WebKit-https.git] / Tools / Scripts / webkitdirs.pm
1 # Copyright (C) 2005-2007, 2010-2016 Apple Inc. All rights reserved.
2 # Copyright (C) 2009 Google Inc. All rights reserved.
3 # Copyright (C) 2011 Research In Motion Limited. All rights reserved.
4 # Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # 1.  Redistributions of source code must retain the above copyright
11 #     notice, this list of conditions and the following disclaimer. 
12 # 2.  Redistributions in binary form must reproduce the above copyright
13 #     notice, this list of conditions and the following disclaimer in the
14 #     documentation and/or other materials provided with the distribution. 
15 # 3.  Neither the name of Apple Inc. ("Apple") nor the names of
16 #     its contributors may be used to endorse or promote products derived
17 #     from this software without specific prior written permission. 
18 #
19 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 # Module to share code to get to WebKit directories.
31
32 use strict;
33 use version;
34 use warnings;
35 use Config;
36 use Cwd qw(realpath);
37 use Digest::MD5 qw(md5_hex);
38 use FindBin;
39 use File::Basename;
40 use File::Find;
41 use File::Path qw(make_path mkpath rmtree);
42 use File::Spec;
43 use File::Temp qw(tempdir);
44 use File::stat;
45 use List::Util;
46 use POSIX;
47 use Time::HiRes qw(usleep);
48 use VCSUtils;
49
50 BEGIN {
51    use Exporter   ();
52    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
53    $VERSION     = 1.00;
54    @ISA         = qw(Exporter);
55    @EXPORT      = qw(
56        &XcodeCoverageSupportOptions
57        &XcodeOptionString
58        &XcodeOptionStringNoConfig
59        &XcodeOptions
60        &XcodeStaticAnalyzerOption
61        &appDisplayNameFromBundle
62        &appendToEnvironmentVariableList
63        &archCommandLineArgumentsForRestrictedEnvironmentVariables
64        &availableXcodeSDKs
65        &baseProductDir
66        &chdirWebKit
67        &checkFrameworks
68        &cmakeArgsFromFeatures
69        &currentSVNRevision
70        &debugSafari
71        &executableProductDir
72        &extractNonHostConfiguration
73        &findOrCreateSimulatorForIOSDevice
74        &iosSimulatorDeviceByName
75        &iosVersion
76        &nmPath
77        &passedConfiguration
78        &prependToEnvironmentVariableList
79        &printHelpAndExitForRunAndDebugWebKitAppIfNeeded
80        &productDir
81        &quitIOSSimulator
82        &relaunchIOSSimulator
83        &restartIOSSimulatorDevice
84        &runIOSWebKitApp
85        &runMacWebKitApp
86        &safariPath
87        &sdkDirectory
88        &sdkPlatformDirectory
89        &setConfiguration
90        &setupMacWebKitEnvironment
91        &sharedCommandLineOptions
92        &sharedCommandLineOptionsUsage
93        &shutDownIOSSimulatorDevice
94        &willUseIOSDeviceSDK
95        &willUseIOSSimulatorSDK
96        DO_NOT_USE_OPEN_COMMAND
97        SIMULATOR_DEVICE_SUFFIX_FOR_WEBKIT_DEVELOPMENT
98        USE_OPEN_COMMAND
99    );
100    %EXPORT_TAGS = ( );
101    @EXPORT_OK   = ();
102 }
103
104 # Ports
105 use constant {
106     AppleWin    => "AppleWin",
107     GTK         => "GTK",
108     iOS         => "iOS",
109     tvOS        => "tvOS",
110     watchOS     => "watchOS",
111     Mac         => "Mac",
112     JSCOnly     => "JSCOnly",
113     PlayStation => "PlayStation",
114     WinCairo    => "WinCairo",
115     WPE         => "WPE",
116     Unknown     => "Unknown"
117 };
118
119 use constant USE_OPEN_COMMAND => 1; # Used in runMacWebKitApp().
120 use constant DO_NOT_USE_OPEN_COMMAND => 2;
121 use constant SIMULATOR_DEVICE_STATE_SHUTDOWN => "1";
122 use constant SIMULATOR_DEVICE_STATE_BOOTED => "3";
123 use constant SIMULATOR_DEVICE_SUFFIX_FOR_WEBKIT_DEVELOPMENT  => "For WebKit Development";
124
125 # See table "Certificate types and names" on <https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW41>.
126 use constant IOS_DEVELOPMENT_CERTIFICATE_NAME_PREFIX => "iPhone Developer: ";
127
128 our @EXPORT_OK;
129
130 my $architecture;
131 my $asanIsEnabled;
132 my $ltoMode;
133 my $numberOfCPUs;
134 my $maxCPULoad;
135 my $baseProductDir;
136 my @baseProductDirOption;
137 my $configuration;
138 my $xcodeSDK;
139 my $configurationForVisualStudio;
140 my $configurationProductDir;
141 my $sourceDir;
142 my $currentSVNRevision;
143 my $didLoadIPhoneSimulatorNotification;
144 my $nmPath;
145 my $osXVersion;
146 my $iosVersion;
147 my $generateDsym;
148 my $isCMakeBuild;
149 my $isGenerateProjectOnly;
150 my $shouldBuild32Bit;
151 my $isWin64;
152 my $isInspectorFrontend;
153 my $portName;
154 my $shouldUseGuardMalloc;
155 my $shouldNotUseNinja;
156 my $xcodeVersion;
157
158 my $unknownPortProhibited = 0;
159
160 # Variables for Win32 support
161 my $programFilesPath;
162 my $vcBuildPath;
163 my $vsInstallDir;
164 my $msBuildInstallDir;
165 my $vsVersion;
166 my $windowsSourceDir;
167 my $winVersion;
168 my $vsWhereFoundInstallation;
169
170 # Defined in VCSUtils.
171 sub exitStatus($);
172
173 sub findMatchingArguments($$);
174 sub hasArgument($$);
175
176 sub sdkDirectory($)
177 {
178     my ($sdkName) = @_;
179     chomp(my $sdkDirectory = `xcrun --sdk '$sdkName' --show-sdk-path`);
180     die "Failed to get SDK path from xcrun: $!" if exitStatus($?);
181     return $sdkDirectory;
182 }
183
184 sub sdkPlatformDirectory($)
185 {
186     my ($sdkName) = @_;
187     chomp(my $sdkPlatformDirectory = `xcrun --sdk '$sdkName' --show-sdk-platform-path`);
188     die "Failed to get SDK platform path from xcrun: $!" if exitStatus($?);
189     return $sdkPlatformDirectory;
190 }
191
192 sub determineSourceDir
193 {
194     return if $sourceDir;
195     $sourceDir = $FindBin::Bin;
196     $sourceDir =~ s|/+$||; # Remove trailing '/' as we would die later
197
198     # walks up path checking each directory to see if it is the main WebKit project dir, 
199     # defined by containing Sources, WebCore, and JavaScriptCore.
200     until ((-d File::Spec->catdir($sourceDir, "Source") && -d File::Spec->catdir($sourceDir, "Source", "WebCore") && -d File::Spec->catdir($sourceDir, "Source", "JavaScriptCore")) || (-d File::Spec->catdir($sourceDir, "Internal") && -d File::Spec->catdir($sourceDir, "OpenSource")))
201     {
202         if ($sourceDir !~ s|/[^/]+$||) {
203             die "Could not find top level webkit directory above source directory using FindBin.\n";
204         }
205     }
206
207     $sourceDir = File::Spec->catdir($sourceDir, "OpenSource") if -d File::Spec->catdir($sourceDir, "OpenSource");
208 }
209
210 sub currentPerlPath()
211 {
212     my $thisPerl = $^X;
213     if ($^O ne 'VMS') {
214         $thisPerl .= $Config{_exe} unless $thisPerl =~ m/$Config{_exe}$/i;
215     }
216     return $thisPerl;
217 }
218
219 # used for scripts which are stored in a non-standard location
220 sub setSourceDir($)
221 {
222     ($sourceDir) = @_;
223 }
224
225 sub determineNinjaVersion
226 {
227     chomp(my $ninjaVersion = `ninja --version`);
228     return $ninjaVersion;
229 }
230
231 sub determineXcodeVersion
232 {
233     return if defined $xcodeVersion;
234     my $xcodebuildVersionOutput = `xcodebuild -version`;
235     $xcodeVersion = ($xcodebuildVersionOutput =~ /Xcode ([0-9]+(\.[0-9]+)*)/) ? $1 : "3.0";
236 }
237
238 sub readXcodeUserDefault($)
239 {
240     my ($key) = @_;
241
242     my $devnull = File::Spec->devnull();
243
244     my $value = `defaults read com.apple.dt.Xcode ${key} 2> ${devnull}`;
245     return if $?;
246
247     chomp $value;
248     return $value;
249 }
250
251 sub determineBaseProductDir
252 {
253     return if defined $baseProductDir;
254     determineSourceDir();
255
256     my $setSharedPrecompsDir;
257     my $indexDataStoreDir;
258     $baseProductDir = $ENV{"WEBKIT_OUTPUTDIR"};
259
260     if (!defined($baseProductDir) and isAppleCocoaWebKit()) {
261         # Silently remove ~/Library/Preferences/xcodebuild.plist which can
262         # cause build failure. The presence of
263         # ~/Library/Preferences/xcodebuild.plist can prevent xcodebuild from
264         # respecting global settings such as a custom build products directory
265         # (<rdar://problem/5585899>).
266         my $personalPlistFile = $ENV{HOME} . "/Library/Preferences/xcodebuild.plist";
267         if (-e $personalPlistFile) {
268             unlink($personalPlistFile) || die "Could not delete $personalPlistFile: $!";
269         }
270
271         my $buildLocationStyle = join '', readXcodeUserDefault("IDEBuildLocationStyle");
272         if ($buildLocationStyle eq "Custom") {
273             my $buildLocationType = join '', readXcodeUserDefault("IDECustomBuildLocationType");
274             # FIXME: Read CustomBuildIntermediatesPath and set OBJROOT accordingly.
275             if ($buildLocationType eq "Absolute") {
276                 $baseProductDir = readXcodeUserDefault("IDECustomBuildProductsPath");
277                 $indexDataStoreDir = readXcodeUserDefault("IDECustomIndexStorePath");
278             }
279         }
280
281         # DeterminedByTargets corresponds to a setting of "Legacy" in Xcode.
282         # It is the only build location style for which SHARED_PRECOMPS_DIR is not
283         # overridden when building from within Xcode.
284         $setSharedPrecompsDir = 1 if $buildLocationStyle ne "DeterminedByTargets";
285
286         if (!defined($baseProductDir)) {
287             $baseProductDir = join '', readXcodeUserDefault("IDEApplicationwideBuildSettings");
288             $baseProductDir = $1 if $baseProductDir =~ /SYMROOT\s*=\s*\"(.*?)\";/s;
289         }
290
291         undef $baseProductDir unless $baseProductDir =~ /^\//;
292     }
293
294     if (!defined($baseProductDir)) { # Port-specific checks failed, use default
295         $baseProductDir = File::Spec->catdir($sourceDir, "WebKitBuild");
296     }
297
298     if (isGit() && isGitBranchBuild()) {
299         my $branch = gitBranch();
300         $baseProductDir = "$baseProductDir/$branch";
301     }
302
303     if (isAppleCocoaWebKit()) {
304         $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;
305         $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;
306         $baseProductDir =~ s|^~/|$ENV{HOME}/|;
307         die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;
308         die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;
309         @baseProductDirOption = ("SYMROOT=$baseProductDir", "OBJROOT=$baseProductDir");
310         push(@baseProductDirOption, "SHARED_PRECOMPS_DIR=${baseProductDir}/PrecompiledHeaders") if $setSharedPrecompsDir;
311         push(@baseProductDirOption, "INDEX_ENABLE_DATA_STORE=YES", "INDEX_DATA_STORE_DIR=${indexDataStoreDir}") if $indexDataStoreDir;
312     }
313
314     if (isCygwin()) {
315         my $dosBuildPath = `cygpath --windows \"$baseProductDir\"`;
316         chomp $dosBuildPath;
317         $ENV{"WEBKIT_OUTPUTDIR"} = $dosBuildPath;
318         my $unixBuildPath = `cygpath --unix \"$baseProductDir\"`;
319         chomp $unixBuildPath;
320         $baseProductDir = $dosBuildPath;
321     }
322 }
323
324 sub systemVerbose {
325     print "+ @_\n";
326     return system(@_);
327 }
328
329 sub setBaseProductDir($)
330 {
331     ($baseProductDir) = @_;
332 }
333
334 sub determineConfiguration
335 {
336     return if defined $configuration;
337     determineBaseProductDir();
338     if (open CONFIGURATION, "$baseProductDir/Configuration") {
339         $configuration = <CONFIGURATION>;
340         close CONFIGURATION;
341     }
342     if ($configuration) {
343         chomp $configuration;
344         # compatibility for people who have old Configuration files
345         $configuration = "Release" if $configuration eq "Deployment";
346         $configuration = "Debug" if $configuration eq "Development";
347     } else {
348         $configuration = "Release";
349     }
350 }
351
352 sub determineArchitecture
353 {
354     return if defined $architecture;
355     # make sure $architecture is defined in all cases
356     $architecture = "";
357
358     determineBaseProductDir();
359     determineXcodeSDK();
360
361     if (isAppleCocoaWebKit()) {
362         if (open ARCHITECTURE, "$baseProductDir/Architecture") {
363             $architecture = <ARCHITECTURE>;
364             close ARCHITECTURE;
365         }
366         if ($architecture) {
367             chomp $architecture;
368         } else {
369             if (not defined $xcodeSDK or $xcodeSDK =~ /^(\/$|macosx)/) {
370                 my $supports64Bit = `sysctl -n hw.optional.x86_64`;
371                 chomp $supports64Bit;
372                 $architecture = 'x86_64' if $supports64Bit;
373             } elsif ($xcodeSDK =~ /^iphonesimulator/) {
374                 $architecture = 'x86_64';
375             } elsif ($xcodeSDK =~ /^iphoneos/) {
376                 $architecture = 'arm64';
377             }
378         }
379     } elsif (isCMakeBuild()) {
380         if (isCrossCompilation()) {
381             my $compiler = "gcc";
382             $compiler = $ENV{'CC'} if (defined($ENV{'CC'}));
383             my @compiler_machine = split('-', `$compiler -dumpmachine`);
384             $architecture = $compiler_machine[0];
385         } elsif (open my $cmake_sysinfo, "cmake --system-information |") {
386             while (<$cmake_sysinfo>) {
387                 next unless index($_, 'CMAKE_SYSTEM_PROCESSOR') == 0;
388                 if (/^CMAKE_SYSTEM_PROCESSOR \"([^"]+)\"/) {
389                     $architecture = $1;
390                     last;
391                 }
392             }
393             close $cmake_sysinfo;
394         }
395     }
396
397     if (!isAnyWindows()) {
398         if (!$architecture) {
399             # Fall back to output of `uname -m', if it is present.
400             $architecture = `uname -m`;
401             chomp $architecture;
402         }
403     }
404
405     $architecture = 'x86_64' if $architecture =~ /amd64/i;
406     $architecture = 'arm64' if $architecture =~ /aarch64/i;
407 }
408
409 sub determineASanIsEnabled
410 {
411     return if defined $asanIsEnabled;
412     determineBaseProductDir();
413
414     $asanIsEnabled = 0;
415     my $asanConfigurationValue;
416
417     if (open ASAN, "$baseProductDir/ASan") {
418         $asanConfigurationValue = <ASAN>;
419         close ASAN;
420         chomp $asanConfigurationValue;
421         $asanIsEnabled = 1 if $asanConfigurationValue eq "YES";
422     }
423 }
424
425 sub determineLTOMode
426 {
427     return if defined $ltoMode;
428     determineBaseProductDir();
429
430     if (open LTO, "$baseProductDir/LTO") {
431         $ltoMode = <LTO>;
432         close LTO;
433         chomp $ltoMode;
434     }
435 }
436
437 sub determineNumberOfCPUs
438 {
439     return if defined $numberOfCPUs;
440     if (defined($ENV{NUMBER_OF_PROCESSORS})) {
441         $numberOfCPUs = $ENV{NUMBER_OF_PROCESSORS};
442     } elsif (isLinux()) {
443         # First try the nproc utility, if it exists. If we get no
444         # results fall back to just interpretting /proc directly.
445         chomp($numberOfCPUs = `nproc --all 2> /dev/null`);
446         if ($numberOfCPUs eq "") {
447             $numberOfCPUs = (grep /processor/, `cat /proc/cpuinfo`);
448         }
449     } elsif (isAnyWindows()) {
450         # Assumes cygwin
451         $numberOfCPUs = `ls /proc/registry/HKEY_LOCAL_MACHINE/HARDWARE/DESCRIPTION/System/CentralProcessor | wc -w`;
452     } elsif (isDarwin() || isBSD()) {
453         chomp($numberOfCPUs = `sysctl -n hw.ncpu`);
454     } else {
455         $numberOfCPUs = 1;
456     }
457 }
458
459 sub determineMaxCPULoad
460 {
461     return if defined $maxCPULoad;
462     if (defined($ENV{MAX_CPU_LOAD})) {
463         $maxCPULoad = $ENV{MAX_CPU_LOAD};
464     }
465 }
466
467 sub jscPath($)
468 {
469     my ($productDir) = @_;
470     my $jscName = "jsc";
471     $jscName .= "_debug"  if configuration() eq "Debug_All";
472     $jscName .= ".exe" if (isAnyWindows());
473     return "$productDir/$jscName" if -e "$productDir/$jscName";
474     return "$productDir/JavaScriptCore.framework/Resources/$jscName";
475 }
476
477 sub argumentsForConfiguration()
478 {
479     determineConfiguration();
480     determineArchitecture();
481     determineXcodeSDK();
482
483     my @args = ();
484     # FIXME: Is it necessary to pass --debug, --release, --32-bit or --64-bit?
485     # These are determined automatically from stored configuration.
486     push(@args, '--debug') if ($configuration =~ "^Debug");
487     push(@args, '--release') if ($configuration =~ "^Release");
488     push(@args, '--ios-device') if (defined $xcodeSDK && $xcodeSDK =~ /^iphoneos/);
489     push(@args, '--ios-simulator') if (defined $xcodeSDK && $xcodeSDK =~ /^iphonesimulator/);
490     push(@args, '--32-bit') if ($architecture eq "x86" and !isWin64());
491     push(@args, '--64-bit') if (isWin64());
492     push(@args, '--gtk') if isGtk();
493     push(@args, '--wpe') if isWPE();
494     push(@args, '--jsc-only') if isJSCOnly();
495     push(@args, '--wincairo') if isWinCairo();
496     push(@args, '--playstation') if isPlayStation();
497     return @args;
498 }
499
500 sub extractNonMacOSHostConfiguration
501 {
502     my @args = ();
503     my @extract = ('--device', '--gtk', '--ios', '--platform', '--sdk', '--simulator', '--wincairo', 'SDKROOT', 'ARCHS');
504     foreach (@{$_[0]}) {
505         my $line = $_;
506         my $flag = 0;
507         foreach (@extract) {
508             if (length($line) >= length($_) && substr($line, 0, length($_)) eq $_
509                 && index($line, 'i386') == -1 && index($line, 'x86_64') == -1) {
510                 $flag = 1;
511             }
512         }
513         if (!$flag) {
514             push @args, $_;
515         }
516     }
517     return @args;
518 }
519
520 # FIXME: Convert to json <rdar://problem/21594308>
521 sub parseAvailableXcodeSDKs($)
522 {
523     my @outputToParse = @{$_[0]};
524     my @result = ();
525     foreach my $line (@outputToParse) {
526         # Examples:
527         #    iOS 12.0 -sdk iphoneos12.0
528         #    Simulator - iOS 12.0 -sdk iphonesimulator12.0
529         #    macOS 10.14 -sdk macosx10.14
530         if ($line =~ /-sdk (\D+)([\d\.]+)(\D*)\n/) {
531             if ($3) {
532                 push @result, "$1.$3";
533             } else {
534                 push @result, "$1";
535             }
536         }
537     }
538     return @result;
539 }
540
541 sub availableXcodeSDKs
542 {
543     my @output = `xcodebuild -showsdks`;
544     return parseAvailableXcodeSDKs(\@output);
545 }
546
547 sub determineXcodeSDK
548 {
549     return if defined $xcodeSDK;
550     my $sdk;
551     
552     # The user explicitly specified the sdk, don't assume anything
553     if (checkForArgumentAndRemoveFromARGVGettingValue("--sdk", \$sdk)) {
554         $xcodeSDK = $sdk;
555         return;
556     }
557     if (checkForArgumentAndRemoveFromARGV("--device") || checkForArgumentAndRemoveFromARGV("--ios-device")) {
558         $xcodeSDK ||= "iphoneos";
559     }
560     if (checkForArgumentAndRemoveFromARGV("--simulator") || checkForArgumentAndRemoveFromARGV("--ios-simulator")) {
561         $xcodeSDK ||= 'iphonesimulator';
562     }
563     if (checkForArgumentAndRemoveFromARGV("--tvos-device")) {
564         $xcodeSDK ||=  "appletvos";
565     }
566     if (checkForArgumentAndRemoveFromARGV("--tvos-simulator")) {
567         $xcodeSDK ||= "appletvsimulator";
568     }
569     if (checkForArgumentAndRemoveFromARGV("--watchos-device")) {
570         $xcodeSDK ||=  "watchos";
571     }
572     if (checkForArgumentAndRemoveFromARGV("--watchos-simulator")) {
573         $xcodeSDK ||= "watchsimulator";
574     }
575     return if !defined $xcodeSDK;
576     
577     # Prefer the internal version of an sdk, if it exists.
578     my @availableSDKs = availableXcodeSDKs();
579
580     foreach my $sdk (@availableSDKs) {
581         next if $sdk ne "$xcodeSDK.internal";
582         $xcodeSDK = $sdk;
583         last;
584     }
585 }
586
587 sub xcodeSDK
588 {
589     determineXcodeSDK();
590     return $xcodeSDK;
591 }
592
593 sub setXcodeSDK($)
594 {
595     ($xcodeSDK) = @_;
596 }
597
598
599 sub xcodeSDKPlatformName()
600 {
601     determineXcodeSDK();
602     return "" if !defined $xcodeSDK;
603     return "appletvos" if $xcodeSDK =~ /appletvos/i;
604     return "appletvsimulator" if $xcodeSDK =~ /appletvsimulator/i;
605     return "iphoneos" if $xcodeSDK =~ /iphoneos/i;
606     return "iphonesimulator" if $xcodeSDK =~ /iphonesimulator/i;
607     return "macosx" if $xcodeSDK =~ /macosx/i;
608     return "watchos" if $xcodeSDK =~ /watchos/i;
609     return "watchsimulator" if $xcodeSDK =~ /watchsimulator/i;
610     die "Couldn't determine platform name from Xcode SDK";
611 }
612
613 sub XcodeSDKPath
614 {
615     determineXcodeSDK();
616
617     die "Can't find the SDK path because no Xcode SDK was specified" if not $xcodeSDK;
618     return sdkDirectory($xcodeSDK);
619 }
620
621 sub xcodeSDKVersion
622 {
623     determineXcodeSDK();
624
625     die "Can't find the SDK version because no Xcode SDK was specified" if !$xcodeSDK;
626
627     chomp(my $sdkVersion = `xcrun --sdk $xcodeSDK --show-sdk-version`);
628     die "Failed to get SDK version from xcrun" if exitStatus($?);
629
630     return $sdkVersion;
631 }
632
633 sub programFilesPath
634 {
635     return $programFilesPath if defined $programFilesPath;
636
637     $programFilesPath = $ENV{'PROGRAMFILES(X86)'} || $ENV{'PROGRAMFILES'} || "C:\\Program Files";
638
639     return $programFilesPath;
640 }
641
642 sub programFilesPathX86
643 {
644     my $programFilesPathX86 = $ENV{'PROGRAMFILES(X86)'} || "C:\\Program Files (x86)";
645
646     return $programFilesPathX86;
647 }
648
649 sub requireModulesForVSWhere
650 {
651     require Encode;
652     require Encode::Locale;
653     require JSON::PP;
654 }
655
656 sub pickCurrentVisualStudioInstallation
657 {
658     return $vsWhereFoundInstallation if defined $vsWhereFoundInstallation;
659
660     requireModulesForVSWhere();
661     determineSourceDir();
662
663     # Prefer Enterprise, then Professional, then Community, then
664     # anything else that provides MSBuild.
665     foreach my $productType ((
666         'Microsoft.VisualStudio.Product.Enterprise',
667         'Microsoft.VisualStudio.Product.Professional',
668         'Microsoft.VisualStudio.Product.Community',
669         undef
670     )) {
671         my $command = "$sourceDir/WebKitLibraries/win/tools/vswhere -nologo -latest -format json -requires Microsoft.Component.MSBuild";
672         if (defined $productType) {
673             $command .= " -products $productType";
674         }
675         my $vsWhereOut = `$command`;
676         my $installations = [];
677         eval {
678             $installations = JSON::PP::decode_json(Encode::encode('UTF-8' => Encode::decode(console_in => $vsWhereOut)));
679         };
680         print "Error getting Visual Studio Location: $@\n" if $@;
681         undef $@;
682
683         if (scalar @$installations) {
684             my $installation = $installations->[0];
685             $vsWhereFoundInstallation = $installation;
686             return $installation;
687         }
688     }
689     return undef;
690 }
691
692 sub visualStudioInstallDir
693 {
694     return $vsInstallDir if defined $vsInstallDir;
695
696     if ($ENV{'VSINSTALLDIR'}) {
697         $vsInstallDir = $ENV{'VSINSTALLDIR'};
698         $vsInstallDir =~ s|[\\/]$||;
699     } else {
700         $vsInstallDir = visualStudioInstallDirVSWhere();
701         if (not -e $vsInstallDir) {
702             $vsInstallDir = visualStudioInstallDirFallback();
703         }
704     }
705     chomp($vsInstallDir = `cygpath "$vsInstallDir"`) if isCygwin();
706
707     print "Using Visual Studio: $vsInstallDir\n";
708     return $vsInstallDir;
709 }
710
711 sub visualStudioInstallDirVSWhere
712 {
713     pickCurrentVisualStudioInstallation();
714     if (defined($vsWhereFoundInstallation)) {
715         return $vsWhereFoundInstallation->{installationPath};
716     }
717     return undef;
718 }
719
720 sub visualStudioInstallDirFallback
721 {
722     foreach my $productType ((
723         'Enterprise',
724         'Professional',
725         'Community',
726     )) {
727         my $installdir = File::Spec->catdir(programFilesPathX86(),
728             "Microsoft Visual Studio", "2017", $productType);
729         my $msbuilddir = File::Spec->catdir($installdir,
730             "MSBuild", "15.0", "bin");
731         if (-e $installdir && -e $msbuilddir) {
732             return $installdir;
733         }
734     }
735     return undef;
736 }
737
738 sub msBuildInstallDir
739 {
740     return $msBuildInstallDir if defined $msBuildInstallDir;
741
742     my $installDir = visualStudioInstallDir();
743     $msBuildInstallDir = File::Spec->catdir($installDir,
744         "MSBuild", "15.0", "bin");
745
746     chomp($msBuildInstallDir = `cygpath "$msBuildInstallDir"`) if isCygwin();
747
748     print "Using MSBuild: $msBuildInstallDir\n";
749     return $msBuildInstallDir;
750 }
751
752 sub determineConfigurationForVisualStudio
753 {
754     return if defined $configurationForVisualStudio;
755     determineConfiguration();
756     # FIXME: We should detect when Debug_All or Production has been chosen.
757     $configurationForVisualStudio = "/p:Configuration=" . $configuration;
758 }
759
760 sub usesPerConfigurationBuildDirectory
761 {
762     # [Gtk] We don't have Release/Debug configurations in straight
763     # autotool builds (non build-webkit). In this case and if
764     # WEBKIT_OUTPUTDIR exist, use that as our configuration dir. This will
765     # allows us to run run-webkit-tests without using build-webkit.
766     return ($ENV{"WEBKIT_OUTPUTDIR"} && isGtk()) || isAppleWinWebKit();
767 }
768
769 sub determineConfigurationProductDir
770 {
771     return if defined $configurationProductDir;
772     determineBaseProductDir();
773     determineConfiguration();
774     if (isAppleWinWebKit() || isWinCairo() || isPlayStation()) {
775         $configurationProductDir = File::Spec->catdir($baseProductDir, $configuration);
776     } else {
777         if (usesPerConfigurationBuildDirectory()) {
778             $configurationProductDir = "$baseProductDir";
779         } else {
780             $configurationProductDir = "$baseProductDir/$configuration";
781             $configurationProductDir .= "-" . xcodeSDKPlatformName() if isEmbeddedWebKit();
782         }
783     }
784 }
785
786 sub setConfigurationProductDir($)
787 {
788     ($configurationProductDir) = @_;
789 }
790
791 sub determineCurrentSVNRevision
792 {
793     # We always update the current SVN revision here, and leave the caching
794     # to currentSVNRevision(), so that changes to the SVN revision while the
795     # script is running can be picked up by calling this function again.
796     determineSourceDir();
797     $currentSVNRevision = svnRevisionForDirectory($sourceDir);
798     return $currentSVNRevision;
799 }
800
801
802 sub chdirWebKit
803 {
804     determineSourceDir();
805     chdir $sourceDir or die;
806 }
807
808 sub baseProductDir
809 {
810     determineBaseProductDir();
811     return $baseProductDir;
812 }
813
814 sub sourceDir
815 {
816     determineSourceDir();
817     return $sourceDir;
818 }
819
820 sub productDir
821 {
822     determineConfigurationProductDir();
823     return $configurationProductDir;
824 }
825
826 sub executableProductDir
827 {
828     my $productDirectory = productDir();
829
830     my $binaryDirectory;
831     if (isAnyWindows()) {
832         $binaryDirectory = isWin64() ? "bin64" : "bin32";
833     } elsif (isGtk() || isJSCOnly() || isWPE()) {
834         $binaryDirectory = "bin";
835     } else {
836         return $productDirectory;
837     }
838
839     return File::Spec->catdir($productDirectory, $binaryDirectory);
840 }
841
842 sub jscProductDir
843 {
844     return executableProductDir();
845 }
846
847 sub configuration()
848 {
849     determineConfiguration();
850     return $configuration;
851 }
852
853 sub asanIsEnabled()
854 {
855     determineASanIsEnabled();
856     return $asanIsEnabled;
857 }
858
859 sub ltoMode()
860 {
861     determineLTOMode();
862     return $ltoMode;
863 }
864
865 sub configurationForVisualStudio()
866 {
867     determineConfigurationForVisualStudio();
868     return $configurationForVisualStudio;
869 }
870
871 sub currentSVNRevision
872 {
873     determineCurrentSVNRevision() if not defined $currentSVNRevision;
874     return $currentSVNRevision;
875 }
876
877 sub generateDsym()
878 {
879     determineGenerateDsym();
880     return $generateDsym;
881 }
882
883 sub determineGenerateDsym()
884 {
885     return if defined($generateDsym);
886     $generateDsym = checkForArgumentAndRemoveFromARGV("--dsym");
887 }
888
889 sub hasIOSDevelopmentCertificate()
890 {
891     return !exitStatus(system("security find-identity -p codesigning | grep '" . IOS_DEVELOPMENT_CERTIFICATE_NAME_PREFIX . "' > /dev/null 2>&1"));
892 }
893
894 sub argumentsForXcode()
895 {
896     my @args = ();
897     push @args, "DEBUG_INFORMATION_FORMAT=dwarf-with-dsym" if generateDsym();
898     return @args;
899 }
900
901 sub XcodeOptions
902 {
903     determineBaseProductDir();
904     determineConfiguration();
905     determineArchitecture();
906     determineASanIsEnabled();
907     determineLTOMode();
908     determineXcodeSDK();
909
910     my @options;
911     push @options, "-UseNewBuildSystem=NO";
912     push @options, "-UseSanitizedBuildSystemEnvironment=YES";
913     push @options, "-ShowBuildOperationDuration=YES";
914     push @options, ("-configuration", $configuration);
915     push @options, ("-xcconfig", sourceDir() . "/Tools/asan/asan.xcconfig", "ASAN_IGNORE=" . sourceDir() . "/Tools/asan/webkit-asan-ignore.txt") if $asanIsEnabled;
916     push @options, "WK_LTO_MODE=$ltoMode" if $ltoMode;
917     push @options, @baseProductDirOption;
918     push @options, "ARCHS=$architecture" if $architecture;
919     push @options, "SDKROOT=$xcodeSDK" if $xcodeSDK;
920     if (willUseIOSDeviceSDK()) {
921         push @options, "ENABLE_BITCODE=NO";
922         if (hasIOSDevelopmentCertificate()) {
923             # FIXME: May match more than one installed development certificate.
924             push @options, "CODE_SIGN_IDENTITY=" . IOS_DEVELOPMENT_CERTIFICATE_NAME_PREFIX;
925         } else {
926             push @options, "CODE_SIGN_IDENTITY="; # No identity
927             push @options, "CODE_SIGNING_REQUIRED=NO";
928         }
929     }
930     push @options, argumentsForXcode();
931     return @options;
932 }
933
934 sub XcodeOptionString
935 {
936     return join " ", XcodeOptions();
937 }
938
939 sub XcodeOptionStringNoConfig
940 {
941     return join " ", @baseProductDirOption;
942 }
943
944 sub XcodeCoverageSupportOptions()
945 {
946     my @coverageSupportOptions = ();
947     push @coverageSupportOptions, "GCC_GENERATE_TEST_COVERAGE_FILES=YES";
948     push @coverageSupportOptions, "GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES";
949     return @coverageSupportOptions;
950 }
951
952 sub XcodeStaticAnalyzerOption()
953 {
954     return "RUN_CLANG_STATIC_ANALYZER=YES";
955 }
956
957 my $passedConfiguration;
958 my $searchedForPassedConfiguration;
959 sub determinePassedConfiguration
960 {
961     return if $searchedForPassedConfiguration;
962     $searchedForPassedConfiguration = 1;
963     $passedConfiguration = undef;
964
965     if (checkForArgumentAndRemoveFromARGV("--debug")) {
966         $passedConfiguration = "Debug";
967     } elsif(checkForArgumentAndRemoveFromARGV("--release")) {
968         $passedConfiguration = "Release";
969     } elsif (checkForArgumentAndRemoveFromARGV("--profile") || checkForArgumentAndRemoveFromARGV("--profiling")) {
970         $passedConfiguration = "Profiling";
971     }
972 }
973
974 sub passedConfiguration
975 {
976     determinePassedConfiguration();
977     return $passedConfiguration;
978 }
979
980 sub setConfiguration
981 {
982     setArchitecture();
983
984     if (my $config = shift @_) {
985         $configuration = $config;
986         return;
987     }
988
989     determinePassedConfiguration();
990     $configuration = $passedConfiguration if $passedConfiguration;
991 }
992
993
994 my $passedArchitecture;
995 my $searchedForPassedArchitecture;
996 sub determinePassedArchitecture
997 {
998     return if $searchedForPassedArchitecture;
999     $searchedForPassedArchitecture = 1;
1000
1001     $passedArchitecture = undef;
1002     if (shouldBuild32Bit()) {
1003         if (isAppleCocoaWebKit()) {
1004             # PLATFORM_IOS: Don't run `arch` command inside Simulator environment
1005             local %ENV = %ENV;
1006             delete $ENV{DYLD_ROOT_PATH};
1007             delete $ENV{DYLD_FRAMEWORK_PATH};
1008
1009             $passedArchitecture = `arch`;
1010             chomp $passedArchitecture;
1011         }
1012     }
1013 }
1014
1015 sub passedArchitecture
1016 {
1017     determinePassedArchitecture();
1018     return $passedArchitecture;
1019 }
1020
1021 sub architecture()
1022 {
1023     determineArchitecture();
1024     return $architecture;
1025 }
1026
1027 sub numberOfCPUs()
1028 {
1029     determineNumberOfCPUs();
1030     return $numberOfCPUs;
1031 }
1032
1033 sub maxCPULoad()
1034 {
1035     determineMaxCPULoad();
1036     return $maxCPULoad;
1037 }
1038
1039 sub setArchitecture
1040 {
1041     if (my $arch = shift @_) {
1042         $architecture = $arch;
1043         return;
1044     }
1045
1046     determinePassedArchitecture();
1047     $architecture = $passedArchitecture if $passedArchitecture;
1048 }
1049
1050 # Locate Safari.
1051 sub safariPath
1052 {
1053     die "Safari path is only relevant on Apple Mac platform\n" unless isAppleMacWebKit();
1054
1055     my $safariPath;
1056
1057     # Use WEBKIT_SAFARI environment variable if present.
1058     my $safariBundle = $ENV{WEBKIT_SAFARI};
1059     if (!$safariBundle) {
1060         determineConfigurationProductDir();
1061         # Use Safari.app in product directory if present (good for Safari development team).
1062         if (-d "$configurationProductDir/Safari.app") {
1063             $safariBundle = "$configurationProductDir/Safari.app";
1064         }
1065     }
1066
1067     if ($safariBundle) {
1068         $safariPath = "$safariBundle/Contents/MacOS/Safari";
1069     } else {
1070         $safariPath = "/Applications/Safari.app/Contents/MacOS/SafariForWebKitDevelopment";
1071     }
1072
1073     die "Can't find executable at $safariPath.\n" if !-x $safariPath;
1074     return $safariPath;
1075 }
1076
1077 sub builtDylibPathForName
1078 {
1079     my $libraryName = shift;
1080     determineConfigurationProductDir();
1081
1082     if (isGtk()) {
1083         my $extension = isDarwin() ? ".dylib" : ".so";
1084         return "$configurationProductDir/lib/libwebkit2gtk-4.0" . $extension;
1085     }
1086     if (isIOSWebKit()) {
1087         return "$configurationProductDir/$libraryName.framework/$libraryName";
1088     }
1089     if (isAppleCocoaWebKit()) {
1090         return "$configurationProductDir/$libraryName.framework/Versions/A/$libraryName";
1091     }
1092     if (isAppleWinWebKit()) {
1093         if ($libraryName eq "JavaScriptCore") {
1094             return "$baseProductDir/lib/$libraryName.lib";
1095         } else {
1096             return "$baseProductDir/$libraryName.intermediate/$configuration/$libraryName.intermediate/$libraryName.lib";
1097         }
1098     }
1099     if (isWPE()) {
1100         return "$configurationProductDir/lib/libWPEWebKit-0.1.so";
1101     }
1102
1103     die "Unsupported platform, can't determine built library locations.\nTry `build-webkit --help` for more information.\n";
1104 }
1105
1106 # Check to see that all the frameworks are built.
1107 sub checkFrameworks # FIXME: This is a poor name since only the Mac calls built WebCore a Framework.
1108 {
1109     return if isAnyWindows();
1110     my @frameworks = ("JavaScriptCore", "WebCore");
1111     push(@frameworks, "WebKit") if isAppleCocoaWebKit(); # FIXME: This seems wrong, all ports should have a WebKit these days.
1112     for my $framework (@frameworks) {
1113         my $path = builtDylibPathForName($framework);
1114         die "Can't find built framework at \"$path\".\n" unless -e $path;
1115     }
1116 }
1117
1118 sub isInspectorFrontend()
1119 {
1120     determineIsInspectorFrontend();
1121     return $isInspectorFrontend;
1122 }
1123
1124 sub determineIsInspectorFrontend()
1125 {
1126     return if defined($isInspectorFrontend);
1127     $isInspectorFrontend = checkForArgumentAndRemoveFromARGV("--inspector-frontend");
1128 }
1129
1130 sub commandExists($)
1131 {
1132     my $command = shift;
1133     my $devnull = File::Spec->devnull();
1134
1135     if (isAnyWindows()) {
1136         return exitStatus(system("where /q $command >$devnull 2>&1")) == 0;
1137     }
1138     return exitStatus(system("which $command >$devnull 2>&1")) == 0;
1139 }
1140
1141 sub checkForArgumentAndRemoveFromARGV($)
1142 {
1143     my $argToCheck = shift;
1144     return checkForArgumentAndRemoveFromArrayRef($argToCheck, \@ARGV);
1145 }
1146
1147 sub checkForArgumentAndRemoveFromArrayRefGettingValue($$$)
1148 {
1149     my ($argToCheck, $valueRef, $arrayRef) = @_;
1150     my $argumentStartRegEx = qr#^$argToCheck(?:=\S|$)#;
1151     my $i = 0;
1152     for (; $i < @$arrayRef; ++$i) {
1153         last if $arrayRef->[$i] =~ $argumentStartRegEx;
1154     }
1155     if ($i >= @$arrayRef) {
1156         return $$valueRef = undef;
1157     }
1158     my ($key, $value) = split("=", $arrayRef->[$i]);
1159     splice(@$arrayRef, $i, 1);
1160     if (defined($value)) {
1161         # e.g. --sdk=iphonesimulator
1162         return $$valueRef = $value;
1163     }
1164     return $$valueRef = splice(@$arrayRef, $i, 1); # e.g. --sdk iphonesimulator
1165 }
1166
1167 sub checkForArgumentAndRemoveFromARGVGettingValue($$)
1168 {
1169     my ($argToCheck, $valueRef) = @_;
1170     return checkForArgumentAndRemoveFromArrayRefGettingValue($argToCheck, $valueRef, \@ARGV);
1171 }
1172
1173 sub findMatchingArguments($$)
1174 {
1175     my ($argToCheck, $arrayRef) = @_;
1176     my @matchingIndices;
1177     foreach my $index (0 .. $#$arrayRef) {
1178         my $opt = $$arrayRef[$index];
1179         if ($opt =~ /^$argToCheck$/i ) {
1180             push(@matchingIndices, $index);
1181         }
1182     }
1183     return @matchingIndices; 
1184 }
1185
1186 sub hasArgument($$)
1187 {
1188     my ($argToCheck, $arrayRef) = @_;
1189     my @matchingIndices = findMatchingArguments($argToCheck, $arrayRef);
1190     return scalar @matchingIndices > 0;
1191 }
1192
1193 sub checkForArgumentAndRemoveFromArrayRef
1194 {
1195     my ($argToCheck, $arrayRef) = @_;
1196     my @indicesToRemove = findMatchingArguments($argToCheck, $arrayRef);
1197     my $removeOffset = 0;
1198     foreach my $index (@indicesToRemove) {
1199         splice(@$arrayRef, $index - $removeOffset++, 1);
1200     }
1201     return scalar @indicesToRemove > 0;
1202 }
1203
1204 sub prohibitUnknownPort()
1205 {
1206     $unknownPortProhibited = 1;
1207 }
1208
1209 sub determinePortName()
1210 {
1211     return if defined $portName;
1212
1213     my %argToPortName = (
1214         gtk => GTK,
1215         'jsc-only' => JSCOnly,
1216         playstation => PlayStation,
1217         wincairo => WinCairo,
1218         wpe => WPE
1219     );
1220
1221     for my $arg (sort keys %argToPortName) {
1222         if (checkForArgumentAndRemoveFromARGV("--$arg")) {
1223             die "Argument '--$arg' conflicts with selected port '$portName'\n"
1224                 if defined $portName;
1225
1226             $portName = $argToPortName{$arg};
1227         }
1228     }
1229
1230     return if defined $portName;
1231
1232     # Port was not selected via command line, use appropriate default value
1233
1234     if (isAnyWindows()) {
1235         $portName = AppleWin;
1236     } elsif (isDarwin()) {
1237         determineXcodeSDK();
1238         if (willUseIOSDeviceSDK() || willUseIOSSimulatorSDK()) {
1239             $portName = iOS;
1240         } elsif (willUseAppleTVDeviceSDK() || willUseAppleTVSimulatorSDK()) {
1241             $portName = tvOS;
1242         } elsif (willUseWatchDeviceSDK() || willUseWatchSimulatorSDK()) {
1243             $portName = watchOS;
1244         } else {
1245             $portName = Mac;
1246         }
1247     } else {
1248         if ($unknownPortProhibited) {
1249             my $portsChoice = join "\n\t", qw(
1250                 --gtk
1251                 --jsc-only
1252                 --wpe
1253             );
1254             die "Please specify which WebKit port to build using one of the following options:"
1255                 . "\n\t$portsChoice\n";
1256         }
1257
1258         # If script is run without arguments we cannot determine port
1259         # TODO: This state should be outlawed
1260         $portName = Unknown;
1261     }
1262 }
1263
1264 sub portName()
1265 {
1266     determinePortName();
1267     return $portName;
1268 }
1269
1270 sub isGtk()
1271 {
1272     return portName() eq GTK;
1273 }
1274
1275 sub isJSCOnly()
1276 {
1277     return portName() eq JSCOnly;
1278 }
1279
1280 sub isWPE()
1281 {
1282     return portName() eq WPE;
1283 }
1284
1285 sub isPlayStation()
1286 {
1287     return portName() eq PlayStation;
1288 }
1289
1290 # Determine if this is debian, ubuntu, linspire, or something similar.
1291 sub isDebianBased()
1292 {
1293     return -e "/etc/debian_version";
1294 }
1295
1296 sub isFedoraBased()
1297 {
1298     return -e "/etc/fedora-release";
1299 }
1300
1301 sub isWinCairo()
1302 {
1303     return portName() eq WinCairo;
1304 }
1305
1306 sub shouldBuild32Bit()
1307 {
1308     determineShouldBuild32Bit();
1309     return $shouldBuild32Bit;
1310 }
1311
1312 sub determineShouldBuild32Bit()
1313 {
1314     return if defined($shouldBuild32Bit);
1315     $shouldBuild32Bit = checkForArgumentAndRemoveFromARGV("--32-bit");
1316 }
1317
1318 sub isWin64()
1319 {
1320     determineIsWin64();
1321     return $isWin64;
1322 }
1323
1324 sub determineIsWin64()
1325 {
1326     return if defined($isWin64);
1327     $isWin64 = checkForArgumentAndRemoveFromARGV("--64-bit") || ((isWinCairo() || isJSCOnly()) && !shouldBuild32Bit());
1328 }
1329
1330 sub determineIsWin64FromArchitecture($)
1331 {
1332     my $arch = shift;
1333     $isWin64 = ($arch eq "x86_64");
1334     return $isWin64;
1335 }
1336
1337 sub isCygwin()
1338 {
1339     return ($^O eq "cygwin") || 0;
1340 }
1341
1342 sub isAnyWindows()
1343 {
1344     return isWindows() || isCygwin();
1345 }
1346
1347 sub determineWinVersion()
1348 {
1349     return if $winVersion;
1350
1351     if (!isAnyWindows()) {
1352         $winVersion = -1;
1353         return;
1354     }
1355
1356     my $versionString = `cmd /c ver`;
1357     $versionString =~ /(\d)\.(\d)\.(\d+)/;
1358
1359     $winVersion = {
1360         major => $1,
1361         minor => $2,
1362         build => $3,
1363     };
1364 }
1365
1366 sub winVersion()
1367 {
1368     determineWinVersion();
1369     return $winVersion;
1370 }
1371
1372 sub isWindows7SP0()
1373 {
1374     return isAnyWindows() && winVersion()->{major} == 6 && winVersion()->{minor} == 1 && winVersion()->{build} == 7600;
1375 }
1376
1377 sub isWindowsVista()
1378 {
1379     return isAnyWindows() && winVersion()->{major} == 6 && winVersion()->{minor} == 0;
1380 }
1381
1382 sub isWindowsXP()
1383 {
1384     return isAnyWindows() && winVersion()->{major} == 5 && winVersion()->{minor} == 1;
1385 }
1386
1387 sub isDarwin()
1388 {
1389     return ($^O eq "darwin") || 0;
1390 }
1391
1392 sub isWindows()
1393 {
1394     return ($^O eq "MSWin32") || 0;
1395 }
1396
1397 sub isLinux()
1398 {
1399     return ($^O eq "linux") || 0;
1400 }
1401
1402 sub isBSD()
1403 {
1404     return ($^O eq "freebsd") || ($^O eq "openbsd") || ($^O eq "netbsd") || 0;
1405 }
1406
1407 sub isX86_64()
1408 {
1409     return (architecture() eq "x86_64") || 0;
1410 }
1411
1412 sub isARM64()
1413 {
1414     return (architecture() eq "arm64") || 0;
1415 }
1416
1417 sub isCrossCompilation()
1418 {
1419     my $compiler = "";
1420     $compiler = $ENV{'CC'} if (defined($ENV{'CC'}));
1421     if ($compiler =~ /gcc/) {
1422         my $compilerOptions = `$compiler -v 2>&1`;
1423         my @host = $compilerOptions =~ m/--host=(.*?)\s/;
1424         my @target = $compilerOptions =~ m/--target=(.*?)\s/;
1425         if ($target[0] ne "" && $host[0] ne "") {
1426                 return ($host[0] ne $target[0]);
1427         } else {
1428                 # $tempDir gets automatically deleted when goes out of scope
1429                 my $tempDir = File::Temp->newdir();
1430                 my $testProgramSourcePath = File::Spec->catfile($tempDir, "testcross.c");
1431                 my $testProgramBinaryPath = File::Spec->catfile($tempDir, "testcross");
1432                 open(my $testProgramSourceHandler, ">", $testProgramSourcePath);
1433                 print $testProgramSourceHandler "int main() { return 0; }\n";
1434                 system("$compiler $testProgramSourcePath -o $testProgramBinaryPath > /dev/null 2>&1") == 0 or return 0;
1435                 # Crosscompiling if the program fails to run (because it was built for other arch)
1436                 system("$testProgramBinaryPath > /dev/null 2>&1") == 0 or return 1;
1437                 return 0;
1438         }
1439     }
1440     return 0;
1441 }
1442
1443 sub isIOSWebKit()
1444 {
1445     return portName() eq iOS;
1446 }
1447
1448 sub isTVOSWebKit()
1449 {
1450     return portName() eq tvOS;
1451 }
1452
1453 sub isWatchOSWebKit()
1454 {
1455     return portName() eq watchOS;
1456 }
1457
1458 sub isEmbeddedWebKit()
1459 {
1460     return isIOSWebKit() || isTVOSWebKit() || isWatchOSWebKit();
1461 }
1462
1463 sub isAppleWebKit()
1464 {
1465     return isAppleCocoaWebKit() || isAppleWinWebKit();
1466 }
1467
1468 sub isAppleMacWebKit()
1469 {
1470     return portName() eq Mac;
1471 }
1472
1473 sub isAppleCocoaWebKit()
1474 {
1475     return isAppleMacWebKit() || isEmbeddedWebKit();
1476 }
1477
1478 sub isAppleWinWebKit()
1479 {
1480     return portName() eq AppleWin;
1481 }
1482
1483 sub iOSSimulatorDevicesPath
1484 {
1485     return "$ENV{HOME}/Library/Developer/CoreSimulator/Devices";
1486 }
1487
1488 sub iOSSimulatorDevices
1489 {
1490     eval "require Foundation";
1491     my $devicesPath = iOSSimulatorDevicesPath();
1492     opendir(DEVICES, $devicesPath);
1493     my @udids = grep {
1494         $_ =~ m/^[0-9A-F]{8}-([0-9A-F]{4}-){3}[0-9A-F]{12}$/;
1495     } readdir(DEVICES);
1496     close(DEVICES);
1497
1498     # FIXME: We should parse the device.plist file ourself and map the dictionary keys in it to known
1499     #        dictionary keys so as to decouple our representation of the plist from the actual structure
1500     #        of the plist, which may change.
1501     my @devices = map {
1502         Foundation::perlRefFromObjectRef(NSDictionary->dictionaryWithContentsOfFile_("$devicesPath/$_/device.plist"));
1503     } @udids;
1504
1505     return @devices;
1506 }
1507
1508 sub createiOSSimulatorDevice
1509 {
1510     my $name = shift;
1511     my $deviceTypeId = shift;
1512     my $runtimeId = shift;
1513
1514     my $created = system("xcrun", "--sdk", "iphonesimulator", "simctl", "create", $name, $deviceTypeId, $runtimeId) == 0;
1515     die "Couldn't create simulator device: $name $deviceTypeId $runtimeId" if not $created;
1516
1517     system("xcrun", "--sdk", "iphonesimulator", "simctl", "list");
1518
1519     print "Waiting for device to be created ...\n";
1520     sleep 5;
1521     for (my $tries = 0; $tries < 5; $tries++){
1522         my @devices = iOSSimulatorDevices();
1523         foreach my $device (@devices) {
1524             return $device if $device->{name} eq $name and $device->{deviceType} eq $deviceTypeId and $device->{runtime} eq $runtimeId;
1525         }
1526         sleep 5;
1527     }
1528     die "Device $name $deviceTypeId $runtimeId wasn't found in " . iOSSimulatorDevicesPath();
1529 }
1530
1531 sub willUseIOSDeviceSDK()
1532 {
1533     return xcodeSDKPlatformName() eq "iphoneos";
1534 }
1535
1536 sub willUseIOSSimulatorSDK()
1537 {
1538     return xcodeSDKPlatformName() eq "iphonesimulator";
1539 }
1540
1541 sub willUseAppleTVDeviceSDK()
1542 {
1543     return xcodeSDKPlatformName() eq "appletvos";
1544 }
1545
1546 sub willUseAppleTVSimulatorSDK()
1547 {
1548     return xcodeSDKPlatformName() eq "appletvsimulator";
1549 }
1550
1551 sub willUseWatchDeviceSDK()
1552 {
1553     return xcodeSDKPlatformName() eq "watchos";
1554 }
1555
1556 sub willUseWatchSimulatorSDK()
1557 {
1558     return xcodeSDKPlatformName() eq "watchsimulator";
1559 }
1560
1561 sub determineNmPath()
1562 {
1563     return if $nmPath;
1564
1565     if (isAppleCocoaWebKit()) {
1566         $nmPath = `xcrun -find nm`;
1567         chomp $nmPath;
1568     }
1569     $nmPath = "nm" if !$nmPath;
1570 }
1571
1572 sub nmPath()
1573 {
1574     determineNmPath();
1575     return $nmPath;
1576 }
1577
1578 sub splitVersionString
1579 {
1580     my $versionString = shift;
1581     my @splitVersion = split(/\./, $versionString);
1582     @splitVersion >= 2 or die "Invalid version $versionString";
1583     $osXVersion = {
1584             "major" => $splitVersion[0],
1585             "minor" => $splitVersion[1],
1586             "subminor" => (defined($splitVersion[2]) ? $splitVersion[2] : 0),
1587     };
1588 }
1589
1590 sub determineOSXVersion()
1591 {
1592     return if $osXVersion;
1593
1594     if (!isDarwin()) {
1595         $osXVersion = -1;
1596         return;
1597     }
1598
1599     my $versionString = `sw_vers -productVersion`;
1600     $osXVersion = splitVersionString($versionString);
1601 }
1602
1603 sub osXVersion()
1604 {
1605     determineOSXVersion();
1606     return $osXVersion;
1607 }
1608
1609 sub determineIOSVersion()
1610 {
1611     return if $iosVersion;
1612
1613     if (!isIOSWebKit()) {
1614         $iosVersion = -1;
1615         return;
1616     }
1617
1618     my $versionString = xcodeSDKVersion();
1619     $iosVersion = splitVersionString($versionString);
1620 }
1621
1622 sub iosVersion()
1623 {
1624     determineIOSVersion();
1625     return $iosVersion;
1626 }
1627
1628 sub isWindowsNT()
1629 {
1630     return $ENV{'OS'} eq 'Windows_NT';
1631 }
1632
1633 sub appendToEnvironmentVariableList($$)
1634 {
1635     my ($name, $value) = @_;
1636
1637     if (defined($ENV{$name})) {
1638         $ENV{$name} .= $Config{path_sep} . $value;
1639     } else {
1640         $ENV{$name} = $value;
1641     }
1642 }
1643
1644 sub prependToEnvironmentVariableList($$)
1645 {
1646     my ($name, $value) = @_;
1647
1648     if (defined($ENV{$name})) {
1649         $ENV{$name} = $value . $Config{path_sep} . $ENV{$name};
1650     } else {
1651         $ENV{$name} = $value;
1652     }
1653 }
1654
1655 sub sharedCommandLineOptions()
1656 {
1657     return (
1658         "g|guard-malloc" => \$shouldUseGuardMalloc,
1659     );
1660 }
1661
1662 sub sharedCommandLineOptionsUsage
1663 {
1664     my %opts = @_;
1665
1666     my %switches = (
1667         '-g|--guard-malloc' => 'Use guardmalloc when running executable',
1668     );
1669
1670     my $indent = " " x ($opts{indent} || 2);
1671     my $switchWidth = List::Util::max(int($opts{switchWidth}), List::Util::max(map { length($_) } keys %switches) + ($opts{brackets} ? 2 : 0));
1672
1673     my $result = "Common switches:\n";
1674
1675     for my $switch (keys %switches) {
1676         my $switchName = $opts{brackets} ? "[" . $switch . "]" : $switch;
1677         $result .= sprintf("%s%-" . $switchWidth . "s %s\n", $indent, $switchName, $switches{$switch});
1678     }
1679
1680     return $result;
1681 }
1682
1683 sub setUpGuardMallocIfNeeded
1684 {
1685     if (!isDarwin()) {
1686         return;
1687     }
1688
1689     if (!defined($shouldUseGuardMalloc)) {
1690         $shouldUseGuardMalloc = checkForArgumentAndRemoveFromARGV("-g") || checkForArgumentAndRemoveFromARGV("--guard-malloc");
1691     }
1692
1693     if ($shouldUseGuardMalloc) {
1694         appendToEnvironmentVariableList("DYLD_INSERT_LIBRARIES", "/usr/lib/libgmalloc.dylib");
1695         appendToEnvironmentVariableList("__XPC_DYLD_INSERT_LIBRARIES", "/usr/lib/libgmalloc.dylib");
1696     }
1697 }
1698
1699 sub relativeScriptsDir()
1700 {
1701     my $scriptDir = File::Spec->catpath("", File::Spec->abs2rel($FindBin::Bin, getcwd()), "");
1702     if ($scriptDir eq "") {
1703         $scriptDir = ".";
1704     }
1705     return $scriptDir;
1706 }
1707
1708 sub launcherPath()
1709 {
1710     my $relativeScriptsPath = relativeScriptsDir();
1711     if (isGtk() || isWPE()) {
1712         if (inFlatpakSandbox()) {
1713             return "Tools/Scripts/run-minibrowser";
1714         }
1715         return "$relativeScriptsPath/run-minibrowser";
1716     } elsif (isAppleWebKit()) {
1717         return "$relativeScriptsPath/run-safari";
1718     }
1719 }
1720
1721 sub launcherName()
1722 {
1723     if (isGtk() || isWPE()) {
1724         return "MiniBrowser";
1725     } elsif (isAppleMacWebKit()) {
1726         return "Safari";
1727     } elsif (isAppleWinWebKit()) {
1728         return "MiniBrowser";
1729     }
1730 }
1731
1732 sub checkRequiredSystemConfig
1733 {
1734     if (isDarwin()) {
1735         chomp(my $productVersion = `sw_vers -productVersion`);
1736         if (eval "v$productVersion" lt v10.10.5) {
1737             print "*************************************************************\n";
1738             print "OS X Yosemite v10.10.5 or later is required to build WebKit.\n";
1739             print "You have " . $productVersion . ", thus the build will most likely fail.\n";
1740             print "*************************************************************\n";
1741         }
1742         determineXcodeVersion();
1743         if (eval "v$xcodeVersion" lt v7.0) {
1744             print "*************************************************************\n";
1745             print "Xcode 7.0 or later is required to build WebKit.\n";
1746             print "You have an earlier version of Xcode, thus the build will\n";
1747             print "most likely fail. The latest Xcode is available from the App Store.\n";
1748             print "*************************************************************\n";
1749         }
1750     }
1751 }
1752
1753 sub determineWindowsSourceDir()
1754 {
1755     return if $windowsSourceDir;
1756     $windowsSourceDir = sourceDir();
1757     chomp($windowsSourceDir = `cygpath -w '$windowsSourceDir'`) if isCygwin();
1758 }
1759
1760 sub windowsSourceDir()
1761 {
1762     determineWindowsSourceDir();
1763     return $windowsSourceDir;
1764 }
1765
1766 sub windowsSourceSourceDir()
1767 {
1768     return File::Spec->catdir(windowsSourceDir(), "Source");
1769 }
1770
1771 sub windowsLibrariesDir()
1772 {
1773     return File::Spec->catdir(windowsSourceDir(), "WebKitLibraries", "win");
1774 }
1775
1776 sub windowsOutputDir()
1777 {
1778     return File::Spec->catdir(windowsSourceDir(), "WebKitBuild");
1779 }
1780
1781 sub fontExists($)
1782 {
1783     my $font = shift;
1784     my $cmd = "reg query \"HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts\" /v \"$font\" 2>&1";
1785     my $val = `$cmd`;
1786     return $? == 0;
1787 }
1788
1789 sub checkInstalledTools()
1790 {
1791     # environment variables. Avoid until this is corrected.
1792     my $pythonVer = `python --version 2>&1`;
1793     die "You must have Python installed to build WebKit.\n" if ($?);
1794
1795     # cURL 7.34.0 has a bug that prevents authentication with opensource.apple.com (and other things using SSL3).
1796     my $curlVer = `curl --version 2> NUL`;
1797     if (!$? and $curlVer =~ "(.*curl.*)") {
1798         $curlVer = $1;
1799         if ($curlVer =~ /libcurl\/7\.34\.0/) {
1800             print "cURL version 7.34.0 has a bug that prevents authentication with SSL v2 or v3.\n";
1801             print "cURL 7.33.0 is known to work. The cURL projects is preparing an update to\n";
1802             print "correct this problem.\n\n";
1803             die "Please install a working cURL and try again.\n";
1804         }
1805     }
1806
1807     # MathML requires fonts that may not ship with Windows.
1808     # Warn the user if they are missing.
1809     my @fonts = ('Cambria & Cambria Math (TrueType)', 'LatinModernMath-Regular (TrueType)', 'STIXMath-Regular (TrueType)');
1810     my @missing = ();
1811     foreach my $font (@fonts) {
1812         push @missing, $font if not fontExists($font);
1813     }
1814
1815     if (scalar @missing > 0) {
1816         print "*************************************************************\n";
1817         print "Mathematical fonts, such as Latin Modern Math are needed to\n";
1818         print "use the MathML feature.  You do not appear to have these fonts\n";
1819         print "on your system.\n\n";
1820         print "You can download a suitable set of fonts from the following URL:\n";
1821         print "https://trac.webkit.org/wiki/MathML/Fonts\n";
1822         print "*************************************************************\n";
1823     }
1824
1825     print "Installed tools are correct for the WebKit build.\n";
1826 }
1827
1828 sub setupAppleWinEnv()
1829 {
1830     return unless isAppleWinWebKit();
1831
1832     checkInstalledTools();
1833
1834     if (isWindowsNT()) {
1835         my $restartNeeded = 0;
1836         my %variablesToSet = ();
1837
1838         # FIXME: We should remove this explicit version check for cygwin once we stop supporting Cygwin 1.7.9 or older versions. 
1839         # https://bugs.webkit.org/show_bug.cgi?id=85791
1840         my $uname_version = (POSIX::uname())[2];
1841         $uname_version =~ s/\(.*\)//;  # Remove the trailing cygwin version, if any.
1842         $uname_version =~ s/\-.*$//; # Remove trailing dash-version content, if any
1843         if (version->parse($uname_version) < version->parse("1.7.10")) {
1844             # Setting the environment variable 'CYGWIN' to 'tty' makes cygwin enable extra support (i.e., termios)
1845             # for UNIX-like ttys in the Windows console
1846             $variablesToSet{CYGWIN} = "tty" unless $ENV{CYGWIN};
1847         }
1848         
1849         # Those environment variables must be set to be able to build inside Visual Studio.
1850         $variablesToSet{WEBKIT_LIBRARIES} = windowsLibrariesDir() unless $ENV{WEBKIT_LIBRARIES};
1851         $variablesToSet{WEBKIT_OUTPUTDIR} = windowsOutputDir() unless $ENV{WEBKIT_OUTPUTDIR};
1852         $variablesToSet{MSBUILDDISABLENODEREUSE} = "1" unless $ENV{MSBUILDDISABLENODEREUSE};
1853         $variablesToSet{_IsNativeEnvironment} = "true" unless $ENV{_IsNativeEnvironment};
1854         $variablesToSet{PreferredToolArchitecture} = "x64" unless $ENV{PreferredToolArchitecture};
1855
1856         foreach my $variable (keys %variablesToSet) {
1857             print "Setting the Environment Variable '" . $variable . "' to '" . $variablesToSet{$variable} . "'\n\n";
1858             my $ret = system "setx", $variable, $variablesToSet{$variable};
1859             if ($ret != 0) {
1860                 system qw(regtool -s set), '\\HKEY_CURRENT_USER\\Environment\\' . $variable, $variablesToSet{$variable};
1861             }
1862             $restartNeeded ||=  $variable eq "WEBKIT_LIBRARIES" || $variable eq "WEBKIT_OUTPUTDIR";
1863         }
1864
1865         if ($restartNeeded) {
1866             print "Please restart your computer before attempting to build inside Visual Studio.\n\n";
1867         }
1868     } else {
1869         if (!defined $ENV{'WEBKIT_LIBRARIES'} || !$ENV{'WEBKIT_LIBRARIES'}) {
1870             print "Warning: You must set the 'WebKit_Libraries' environment variable\n";
1871             print "         to be able build WebKit from within Visual Studio 2017 and newer.\n";
1872             print "         Make sure that 'WebKit_Libraries' points to the\n";
1873             print "         'WebKitLibraries/win' directory, not the 'WebKitLibraries/' directory.\n\n";
1874         }
1875         if (!defined $ENV{'WEBKIT_OUTPUTDIR'} || !$ENV{'WEBKIT_OUTPUTDIR'}) {
1876             print "Warning: You must set the 'WebKit_OutputDir' environment variable\n";
1877             print "         to be able build WebKit from within Visual Studio 2017 and newer.\n\n";
1878         }
1879         if (!defined $ENV{'MSBUILDDISABLENODEREUSE'} || !$ENV{'MSBUILDDISABLENODEREUSE'}) {
1880             print "Warning: You should set the 'MSBUILDDISABLENODEREUSE' environment variable to '1'\n";
1881             print "         to avoid periodic locked log files when building.\n\n";
1882         }
1883     }
1884     # FIXME (125180): Remove the following temporary 64-bit support once official support is available.
1885     if (isWin64() and !$ENV{'WEBKIT_64_SUPPORT'}) {
1886         print "Warning: You must set the 'WEBKIT_64_SUPPORT' environment variable\n";
1887         print "         to be able run WebKit or JavaScriptCore tests.\n\n";
1888     }
1889 }
1890
1891 sub setupCygwinEnv()
1892 {
1893     return if !isAnyWindows();
1894     return if $vcBuildPath;
1895
1896     my $programFilesPath = programFilesPath();
1897     my $visualStudioPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE devenv.com));
1898
1899     print "Building results into: ", baseProductDir(), "\n";
1900     print "WEBKIT_OUTPUTDIR is set to: ", $ENV{"WEBKIT_OUTPUTDIR"}, "\n";
1901     print "WEBKIT_LIBRARIES is set to: ", $ENV{"WEBKIT_LIBRARIES"}, "\n";
1902     # FIXME (125180): Remove the following temporary 64-bit support once official support is available.
1903     print "WEBKIT_64_SUPPORT is set to: ", $ENV{"WEBKIT_64_SUPPORT"}, "\n" if isWin64();
1904
1905     # We will actually use MSBuild to build WebKit, but we need to find the Visual Studio install (above) to make
1906     # sure we use the right options.
1907     $vcBuildPath = File::Spec->catfile(msBuildInstallDir(), qw(MSBuild.exe));
1908     if (! -e $vcBuildPath) {
1909         print "*************************************************************\n";
1910         print "Cannot find '$vcBuildPath'\n";
1911         print "Please make sure execute that the Microsoft .NET Framework SDK\n";
1912         print "is installed on this machine.\n";
1913         print "*************************************************************\n";
1914         die;
1915     }
1916 }
1917
1918 sub buildXCodeProject($$@)
1919 {
1920     my ($project, $clean, @extraOptions) = @_;
1921
1922     if ($clean) {
1923         push(@extraOptions, "-alltargets");
1924         push(@extraOptions, "clean");
1925     }
1926
1927     chomp($ENV{DSYMUTIL_NUM_THREADS} = `sysctl -n hw.activecpu`);
1928     return system "xcodebuild", "-project", "$project.xcodeproj", @extraOptions;
1929 }
1930
1931 sub getMSBuildPlatformArgument()
1932 {
1933     if (isPlayStation()) {
1934         return "";
1935     } elsif (isWin64()) {
1936         return "/p:Platform=x64";
1937     } else {
1938         return "/p:Platform=Win32";
1939     }
1940 }
1941
1942 sub buildVisualStudioProject
1943 {
1944     my ($project, $clean) = @_;
1945     setupCygwinEnv();
1946
1947     my $config = configurationForVisualStudio();
1948
1949     chomp($project = `cygpath -w "$project"`) if isCygwin();
1950
1951     my $action = "/t:build";
1952     if ($clean) {
1953         $action = "/t:clean";
1954     }
1955
1956     my $platform = getMSBuildPlatformArgument();
1957     my $logPath = File::Spec->catdir($baseProductDir, $configuration);
1958     make_path($logPath) unless -d $logPath or $logPath eq ".";
1959
1960     my $errorLogFile = File::Spec->catfile($logPath, "webkit_errors.log");
1961     chomp($errorLogFile = `cygpath -w "$errorLogFile"`) if isCygwin();
1962     my $errorLogging = "/flp:LogFile=" . $errorLogFile . ";ErrorsOnly";
1963
1964     my $warningLogFile = File::Spec->catfile($logPath, "webkit_warnings.log");
1965     chomp($warningLogFile = `cygpath -w "$warningLogFile"`) if isCygwin();
1966     my $warningLogging = "/flp1:LogFile=" . $warningLogFile . ";WarningsOnly";
1967
1968     my $maxCPUCount = '/maxcpucount:' . numberOfCPUs();
1969
1970     my @command = ($vcBuildPath, "/verbosity:minimal", $project, $action, $config, $platform, "/fl", $errorLogging, "/fl1", $warningLogging, $maxCPUCount);
1971     print join(" ", @command), "\n";
1972     return system @command;
1973 }
1974
1975 sub getJhbuildPath()
1976 {
1977     my @jhbuildPath = File::Spec->splitdir(baseProductDir());
1978     if (isGit() && isGitBranchBuild() && gitBranch()) {
1979         pop(@jhbuildPath);
1980     }
1981     if (isGtk()) {
1982         push(@jhbuildPath, "DependenciesGTK");
1983     } elsif (isWPE()) {
1984         push(@jhbuildPath, "DependenciesWPE");
1985     } else {
1986         die "Cannot get JHBuild path for platform that isn't GTK+ or WPE.\n";
1987     }
1988     return File::Spec->catdir(@jhbuildPath);
1989 }
1990
1991 sub getFlatpakPath()
1992 {
1993     my @flatpakBuildPath = File::Spec->splitdir(baseProductDir());
1994     if (isGtk()) {
1995         push(@flatpakBuildPath, "GTK");
1996     } elsif (isWPE()) {
1997         push(@flatpakBuildPath, "WPE");
1998     } else {
1999         die "Cannot get Flatpak path for platform that isn't GTK+ or WPE.\n";
2000     }
2001     my @configuration = configuration();
2002     push(@flatpakBuildPath, "FlatpakTree$configuration");
2003
2004     return File::Spec->catdir(@flatpakBuildPath);
2005 }
2006
2007 sub isCachedArgumentfileOutOfDate($@)
2008 {
2009     my ($filename, $currentContents) = @_;
2010
2011     if (! -e $filename) {
2012         return 1;
2013     }
2014
2015     open(CONTENTS_FILE, $filename);
2016     chomp(my $previousContents = <CONTENTS_FILE> || "");
2017     close(CONTENTS_FILE);
2018
2019     if ($previousContents ne $currentContents) {
2020         print "Contents for file $filename have changed.\n";
2021         print "Previous contents were: $previousContents\n\n";
2022         print "New contents are: $currentContents\n";
2023         return 1;
2024     }
2025
2026     return 0;
2027 }
2028
2029 sub inFlatpakSandbox()
2030 {
2031     if (-f "/.flatpak-info") {
2032         return 1;
2033     }
2034
2035     return 0;
2036 }
2037
2038 sub runInFlatpak(@)
2039 {
2040     my @arg = @_;
2041     my @command = (File::Spec->catfile(sourceDir(), "Tools", "Scripts", "webkit-flatpak"));
2042     exec @command, argumentsForConfiguration(), "--command", @_, argumentsForConfiguration(), @ARGV or die;
2043 }
2044
2045 sub runInFlatpakIfAvailable(@)
2046 {
2047     if (inFlatpakSandbox()) {
2048         return 0;
2049     }
2050
2051     my @command = (File::Spec->catfile(sourceDir(), "Tools", "Scripts", "webkit-flatpak"));
2052     if (system(@command, "--available") != 0) {
2053         return 0;
2054     }
2055
2056     if (! -e getFlatpakPath()) {
2057         return 0;
2058     }
2059
2060     runInFlatpak(@_)
2061 }
2062
2063 sub wrapperPrefixIfNeeded()
2064 {
2065
2066     if (isAnyWindows() || isJSCOnly() || isPlayStation()) {
2067         return ();
2068     }
2069     if (isAppleCocoaWebKit()) {
2070         return ("xcrun");
2071     }
2072     if (-e getJhbuildPath()) {
2073         my @prefix = (File::Spec->catfile(sourceDir(), "Tools", "jhbuild", "jhbuild-wrapper"));
2074         if (isGtk()) {
2075             push(@prefix, "--gtk");
2076         } elsif (isWPE()) {
2077             push(@prefix, "--wpe");
2078         }
2079         push(@prefix, "run");
2080
2081         return @prefix;
2082     }
2083
2084     return ();
2085 }
2086
2087 sub shouldUseJhbuild()
2088 {
2089     return ((isGtk() or isWPE()) and -e getJhbuildPath());
2090 }
2091
2092 sub shouldUseFlatpak()
2093 {
2094     return ((isGtk() or isWPE()) and ! inFlatpakSandbox() and -e getFlatpakPath());
2095 }
2096
2097 sub cmakeCachePath()
2098 {
2099     return File::Spec->catdir(baseProductDir(), configuration(), "CMakeCache.txt");
2100 }
2101
2102 sub cmakeFilesPath()
2103 {
2104     return File::Spec->catdir(baseProductDir(), configuration(), "CMakeFiles");
2105 }
2106
2107 sub shouldRemoveCMakeCache(@)
2108 {
2109     my ($cacheFilePath, @buildArgs) = @_;
2110
2111     # We check this first, because we always want to create this file for a fresh build.
2112     my $productDir = File::Spec->catdir(baseProductDir(), configuration());
2113     my $optionsCache = File::Spec->catdir($productDir, "build-webkit-options.txt");
2114     my $joinedBuildArgs = join(" ", @buildArgs);
2115     if (isCachedArgumentfileOutOfDate($optionsCache, $joinedBuildArgs)) {
2116         File::Path::mkpath($productDir) unless -d $productDir;
2117         open(CACHED_ARGUMENTS, ">", $optionsCache);
2118         print CACHED_ARGUMENTS $joinedBuildArgs;
2119         close(CACHED_ARGUMENTS);
2120
2121         return 1;
2122     }
2123
2124     my $cmakeCache = cmakeCachePath();
2125     unless (-e $cmakeCache) {
2126         return 0;
2127     }
2128
2129     my $cacheFileModifiedTime = stat($cmakeCache)->mtime;
2130     my $platformConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "Options" . cmakeBasedPortName() . ".cmake");
2131     if ($cacheFileModifiedTime < stat($platformConfiguration)->mtime) {
2132         return 1;
2133     }
2134
2135     my $globalConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "OptionsCommon.cmake");
2136     if ($cacheFileModifiedTime < stat($globalConfiguration)->mtime) {
2137         return 1;
2138     }
2139
2140     # FIXME: This probably does not work as expected, or the next block to
2141     # delete the images subdirectory would not be here. Directory mtime does not
2142     # percolate upwards when files are added or removed from subdirectories.
2143     my $inspectorUserInterfaceDirectory = File::Spec->catdir(sourceDir(), "Source", "WebInspectorUI", "UserInterface");
2144     if ($cacheFileModifiedTime < stat($inspectorUserInterfaceDirectory)->mtime) {
2145         return 1;
2146     }
2147
2148     my $inspectorImageDirectory = File::Spec->catdir(sourceDir(), "Source", "WebInspectorUI", "UserInterface", "Images");
2149     if ($cacheFileModifiedTime < stat($inspectorImageDirectory)->mtime) {
2150         return 1;
2151     }
2152
2153     if(isAnyWindows()) {
2154         my $winConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "OptionsWin.cmake");
2155         if ($cacheFileModifiedTime < stat($winConfiguration)->mtime) {
2156             return 1;
2157         }
2158     }
2159
2160     return 0;
2161 }
2162
2163 sub removeCMakeCache(@)
2164 {
2165     my (@buildArgs) = @_;
2166     if (shouldRemoveCMakeCache(@buildArgs)) {
2167         my $cmakeCache = cmakeCachePath();
2168         my $cmakeFiles = cmakeFilesPath();
2169         unlink($cmakeCache) if -e $cmakeCache;
2170         rmtree($cmakeFiles) if -d $cmakeFiles;
2171     }
2172 }
2173
2174 sub canUseNinja(@)
2175 {
2176     if (!defined($shouldNotUseNinja)) {
2177         $shouldNotUseNinja = checkForArgumentAndRemoveFromARGV("--no-ninja");
2178     }
2179
2180     if ($shouldNotUseNinja) {
2181         return 0;
2182     }
2183
2184     if (isAppleCocoaWebKit()) {
2185         my $devnull = File::Spec->devnull();
2186         if (exitStatus(system("xcrun -find ninja >$devnull 2>&1")) == 0) {
2187             return 1;
2188         }
2189     }
2190
2191     # Test both ninja and ninja-build. Fedora uses ninja-build and has patched CMake to also call ninja-build.
2192     return commandExists("ninja") || commandExists("ninja-build");
2193 }
2194
2195 sub canUseEclipseNinjaGenerator(@)
2196 {
2197     # Check that eclipse and eclipse Ninja generator is installed
2198     my $devnull = File::Spec->devnull();
2199     return commandExists("eclipse") && exitStatus(system("cmake -N -G 'Eclipse CDT4 - Ninja' >$devnull 2>&1")) == 0;
2200 }
2201
2202 sub cmakeGeneratedBuildfile(@)
2203 {
2204     my ($willUseNinja) = @_;
2205     if ($willUseNinja) {
2206         return File::Spec->catfile(baseProductDir(), configuration(), "build.ninja")
2207     } elsif (isAnyWindows()) {
2208         return File::Spec->catfile(baseProductDir(), configuration(), "WebKit.sln")
2209     } else {
2210         return File::Spec->catfile(baseProductDir(), configuration(), "Makefile")
2211     }
2212 }
2213
2214 sub generateBuildSystemFromCMakeProject
2215 {
2216     my ($prefixPath, @cmakeArgs) = @_;
2217     my $config = configuration();
2218     my $port = cmakeBasedPortName();
2219     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
2220     File::Path::mkpath($buildPath) unless -d $buildPath;
2221     my $originalWorkingDirectory = getcwd();
2222     chdir($buildPath) or die;
2223
2224     # We try to be smart about when to rerun cmake, so that we can have faster incremental builds.
2225     my $willUseNinja = canUseNinja();
2226     if (-e cmakeCachePath() && -e cmakeGeneratedBuildfile($willUseNinja)) {
2227         return 0;
2228     }
2229
2230     my @args;
2231     push @args, "-DPORT=\"$port\"";
2232     push @args, "-DCMAKE_INSTALL_PREFIX=\"$prefixPath\"" if $prefixPath;
2233     push @args, "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON";
2234     if ($config =~ /release/i) {
2235         push @args, "-DCMAKE_BUILD_TYPE=Release";
2236     } elsif ($config =~ /debug/i) {
2237         push @args, "-DCMAKE_BUILD_TYPE=Debug";
2238     }
2239
2240     push @args, "-DENABLE_ADDRESS_SANITIZER=ON" if asanIsEnabled();
2241
2242     push @args, '-DCMAKE_TOOLCHAIN_FILE=Platform/PlayStation' if isPlayStation();
2243
2244     if ($willUseNinja) {
2245         push @args, "-G";
2246         if (canUseEclipseNinjaGenerator()) {
2247             push @args, "'Eclipse CDT4 - Ninja'";
2248         } else {
2249             push @args, "Ninja";
2250         }
2251         push @args, "-DUSE_THIN_ARCHIVES=OFF" if isPlayStation();
2252     } elsif (isAnyWindows() && isWin64()) {
2253         push @args, '-G "Visual Studio 15 2017 Win64"';
2254         push @args, '-DCMAKE_GENERATOR_TOOLSET="host=x64"';
2255     } elsif (isPlayStation()) {
2256         push @args, '-G "Visual Studio 15"';
2257     }
2258
2259     # Do not show progress of generating bindings in interactive Ninja build not to leave noisy lines on tty
2260     push @args, '-DSHOW_BINDINGS_GENERATION_PROGRESS=1' unless ($willUseNinja && -t STDOUT);
2261
2262     # Some ports have production mode, but build-webkit should always use developer mode.
2263     push @args, "-DDEVELOPER_MODE=ON" if isGtk() || isJSCOnly() || isWPE() || isWinCairo();
2264
2265     push @args, @cmakeArgs if @cmakeArgs;
2266
2267     my $cmakeSourceDir = isCygwin() ? windowsSourceDir() : sourceDir();
2268     push @args, '"' . $cmakeSourceDir . '"';
2269
2270     # Compiler options to keep floating point values consistent
2271     # between 32-bit and 64-bit architectures.
2272     determineArchitecture();
2273     if ($architecture eq "i686" && !isCrossCompilation() && !isAnyWindows()) {
2274         $ENV{'CXXFLAGS'} = "-march=pentium4 -msse2 -mfpmath=sse " . ($ENV{'CXXFLAGS'} || "");
2275     }
2276
2277     # We call system("cmake @args") instead of system("cmake", @args) so that @args is
2278     # parsed for shell metacharacters.
2279     my $wrapper = join(" ", wrapperPrefixIfNeeded()) . " ";
2280     my $returnCode = systemVerbose($wrapper . "cmake @args");
2281
2282     chdir($originalWorkingDirectory);
2283     return $returnCode;
2284 }
2285
2286 sub buildCMakeGeneratedProject($)
2287 {
2288     my (@makeArgs) = @_;
2289     my $config = configuration();
2290     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
2291     if (! -d $buildPath) {
2292         die "Must call generateBuildSystemFromCMakeProject() before building CMake project.";
2293     }
2294
2295     if ($ENV{VERBOSE} && canUseNinja()) {
2296         push @makeArgs, "-v";
2297         push @makeArgs, "-d keeprsp" if (version->parse(determineNinjaVersion()) >= version->parse("1.4.0"));
2298     }
2299
2300     my $command = "cmake";
2301     my @args = ("--build", $buildPath, "--config", $config);
2302     push @args, ("--", @makeArgs) if @makeArgs;
2303
2304     # GTK and JSCOnly can use a build script to preserve colors and pretty-printing.
2305     if ((isGtk() || isJSCOnly()) && -e "$buildPath/build.sh") {
2306         chdir "$buildPath" or die;
2307         $command = "$buildPath/build.sh";
2308         @args = (@makeArgs);
2309     }
2310
2311     # We call system("cmake @args") instead of system("cmake", @args) so that @args is
2312     # parsed for shell metacharacters. In particular, @makeArgs may contain such metacharacters.
2313     my $wrapper = join(" ", wrapperPrefixIfNeeded()) . " ";
2314     return systemVerbose($wrapper . "$command @args");
2315 }
2316
2317 sub cleanCMakeGeneratedProject()
2318 {
2319     my $config = configuration();
2320     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
2321     if (-d $buildPath) {
2322         return systemVerbose("cmake", "--build", $buildPath, "--config", $config, "--target", "clean");
2323     }
2324     return 0;
2325 }
2326
2327 sub buildCMakeProjectOrExit($$$@)
2328 {
2329     my ($clean, $prefixPath, $makeArgs, @cmakeArgs) = @_;
2330     my $returnCode;
2331
2332     exit(exitStatus(cleanCMakeGeneratedProject())) if $clean;
2333
2334     if (isGtk() && checkForArgumentAndRemoveFromARGV("--update-gtk")) {
2335         system("perl", "$sourceDir/Tools/Scripts/update-webkitgtk-libs") == 0 or die $!;
2336     }
2337
2338     if (isWPE() && checkForArgumentAndRemoveFromARGV("--update-wpe")) {
2339         system("perl", "$sourceDir/Tools/Scripts/update-webkitwpe-libs") == 0 or die $!;
2340     }
2341
2342     $returnCode = exitStatus(generateBuildSystemFromCMakeProject($prefixPath, @cmakeArgs));
2343     exit($returnCode) if $returnCode;
2344     exit 0 if isGenerateProjectOnly();
2345
2346     $returnCode = exitStatus(buildCMakeGeneratedProject($makeArgs));
2347     exit($returnCode) if $returnCode;
2348     return 0;
2349 }
2350
2351 sub cmakeArgsFromFeatures(\@;$)
2352 {
2353     my ($featuresArrayRef, $enableExperimentalFeatures) = @_;
2354
2355     my @args;
2356     push @args, "-DENABLE_EXPERIMENTAL_FEATURES=ON" if $enableExperimentalFeatures;
2357     foreach (@$featuresArrayRef) {
2358         my $featureName = $_->{define};
2359         if ($featureName) {
2360             my $featureValue = ${$_->{value}}; # Undef to let the build system use its default.
2361             if (defined($featureValue)) {
2362                 my $featureEnabled = $featureValue ? "ON" : "OFF";
2363                 push @args, "-D$featureName=$featureEnabled";
2364             }
2365         }
2366     }
2367     return @args;
2368 }
2369
2370 sub cmakeBasedPortName()
2371 {
2372     return ucfirst portName();
2373 }
2374
2375 sub determineIsCMakeBuild()
2376 {
2377     return if defined($isCMakeBuild);
2378     $isCMakeBuild = checkForArgumentAndRemoveFromARGV("--cmake");
2379 }
2380
2381 sub isCMakeBuild()
2382 {
2383     return 1 unless isAppleCocoaWebKit();
2384     determineIsCMakeBuild();
2385     return $isCMakeBuild;
2386 }
2387
2388 sub determineIsGenerateProjectOnly()
2389 {
2390     return if defined($isGenerateProjectOnly);
2391     $isGenerateProjectOnly = checkForArgumentAndRemoveFromARGV("--generate-project-only");
2392 }
2393
2394 sub isGenerateProjectOnly()
2395 {
2396     determineIsGenerateProjectOnly();
2397     return $isGenerateProjectOnly;
2398 }
2399
2400 sub promptUser
2401 {
2402     my ($prompt, $default) = @_;
2403     my $defaultValue = $default ? "[$default]" : "";
2404     print "$prompt $defaultValue: ";
2405     chomp(my $input = <STDIN>);
2406     return $input ? $input : $default;
2407 }
2408
2409 sub appleApplicationSupportPath
2410 {
2411     open INSTALL_DIR, "</proc/registry/HKEY_LOCAL_MACHINE/SOFTWARE/Apple\ Inc./Apple\ Application\ Support/InstallDir";
2412     my $path = <INSTALL_DIR>;
2413     $path =~ s/[\r\n\x00].*//;
2414     close INSTALL_DIR;
2415
2416     my $unixPath = `cygpath -u '$path'`;
2417     chomp $unixPath;
2418     return $unixPath;
2419 }
2420
2421 sub setPathForRunningWebKitApp
2422 {
2423     my ($env) = @_;
2424
2425     if (isAnyWindows()) {
2426         my $productBinaryDir = executableProductDir();
2427         if (isAppleWinWebKit()) {
2428             $env->{PATH} = join(':', $productBinaryDir, appleApplicationSupportPath(), $env->{PATH} || "");
2429         } elsif (isWinCairo()) {
2430             my $winCairoBin = sourceDir() . "/WebKitLibraries/win/" . (isWin64() ? "bin64/" : "bin32/");
2431             my $gstreamerBin = isWin64() ? $ENV{"GSTREAMER_1_0_ROOT_X86_64"} . "bin" : $ENV{"GSTREAMER_1_0_ROOT_X86"} . "bin";
2432             $env->{PATH} = join(':', $productBinaryDir, $winCairoBin, $gstreamerBin, $env->{PATH} || "");
2433         }
2434     }
2435 }
2436
2437 sub printHelpAndExitForRunAndDebugWebKitAppIfNeeded
2438 {
2439     return unless checkForArgumentAndRemoveFromARGV("--help");
2440
2441     print STDERR <<EOF;
2442 Usage: @{[basename($0)]} [options] [args ...]
2443   --help                            Show this help message
2444   --no-saved-state                  Launch the application without state restoration
2445
2446 Options specific to macOS:
2447   -g|--guard-malloc                 Enable Guard Malloc
2448   --lang=LANGUAGE                   Use a specific language instead of system language.
2449                                     This accepts a language name (German) or a language code (de, ar, pt_BR, etc).
2450   --locale=LOCALE                   Use a specific locale instead of the system region.
2451 EOF
2452
2453     exit(1);
2454 }
2455
2456 sub argumentsForRunAndDebugMacWebKitApp()
2457 {
2458     my @args = ();
2459     if (checkForArgumentAndRemoveFromARGV("--no-saved-state")) {
2460         push @args, ("-ApplePersistenceIgnoreStateQuietly", "YES");
2461         # FIXME: Don't set ApplePersistenceIgnoreState once all supported OS versions respect ApplePersistenceIgnoreStateQuietly (rdar://15032886).
2462         push @args, ("-ApplePersistenceIgnoreState", "YES");
2463     }
2464
2465     my $lang;
2466     if (checkForArgumentAndRemoveFromARGVGettingValue("--lang", \$lang)) {
2467         push @args, ("-AppleLanguages", "(" . $lang . ")");
2468     }
2469
2470     my $locale;
2471     if (checkForArgumentAndRemoveFromARGVGettingValue("--locale", \$locale)) {
2472         push @args, ("-AppleLocale", $locale);
2473     }
2474
2475     unshift @args, @ARGV;
2476
2477     return @args;
2478 }
2479
2480 sub setupMacWebKitEnvironment($)
2481 {
2482     my ($dyldFrameworkPath) = @_;
2483
2484     $dyldFrameworkPath = File::Spec->rel2abs($dyldFrameworkPath);
2485
2486     prependToEnvironmentVariableList("DYLD_FRAMEWORK_PATH", $dyldFrameworkPath);
2487     prependToEnvironmentVariableList("__XPC_DYLD_FRAMEWORK_PATH", $dyldFrameworkPath);
2488     prependToEnvironmentVariableList("DYLD_LIBRARY_PATH", $dyldFrameworkPath);
2489     prependToEnvironmentVariableList("__XPC_DYLD_LIBRARY_PATH", $dyldFrameworkPath);
2490     $ENV{WEBKIT_UNSET_DYLD_FRAMEWORK_PATH} = "YES";
2491
2492     setUpGuardMallocIfNeeded();
2493 }
2494
2495 sub setupIOSWebKitEnvironment($)
2496 {
2497     my ($dyldFrameworkPath) = @_;
2498     $dyldFrameworkPath = File::Spec->rel2abs($dyldFrameworkPath);
2499
2500     prependToEnvironmentVariableList("DYLD_FRAMEWORK_PATH", $dyldFrameworkPath);
2501     prependToEnvironmentVariableList("DYLD_LIBRARY_PATH", $dyldFrameworkPath);
2502
2503     setUpGuardMallocIfNeeded();
2504 }
2505
2506 sub iosSimulatorApplicationsPath()
2507 {
2508     # FIXME: We should ask simctl for this information, instead of guessing from available runtimes.
2509     my $runtimePath = File::Spec->catdir(sdkPlatformDirectory("iphoneos"), "Developer", "Library", "CoreSimulator", "Profiles", "Runtimes");
2510     opendir(RUNTIMES, $runtimePath);
2511     my @runtimes = grep {/.*\.simruntime/} readdir(RUNTIMES);
2512     close(RUNTIMES);
2513     my $sult = File::Spec->catdir($runtimePath, @runtimes ? $runtimes[0] : "iOS.simruntime", "Contents", "Resources", "RuntimeRoot", "Applications");
2514     return $sult;
2515 }
2516
2517 sub installedMobileSafariBundle()
2518 {
2519     return File::Spec->catfile(iosSimulatorApplicationsPath(), "MobileSafari.app");
2520 }
2521
2522 sub mobileSafariBundle()
2523 {
2524     determineConfigurationProductDir();
2525
2526     # Use MobileSafari.app in product directory if present.
2527     if (isIOSWebKit() && -d "$configurationProductDir/MobileSafari.app") {
2528         return "$configurationProductDir/MobileSafari.app";
2529     }
2530     return installedMobileSafariBundle();
2531 }
2532
2533 sub plistPathFromBundle($)
2534 {
2535     my ($appBundle) = @_;
2536     return "$appBundle/Info.plist" if -f "$appBundle/Info.plist"; # iOS app bundle
2537     return "$appBundle/Contents/Info.plist" if -f "$appBundle/Contents/Info.plist"; # Mac app bundle
2538     return "";
2539 }
2540
2541 sub appIdentifierFromBundle($)
2542 {
2543     my ($appBundle) = @_;
2544     my $plistPath = File::Spec->rel2abs(plistPathFromBundle($appBundle)); # defaults(1) will complain if the specified path is not absolute.
2545     chomp(my $bundleIdentifier = `defaults read '$plistPath' CFBundleIdentifier 2> /dev/null`);
2546     return $bundleIdentifier;
2547 }
2548
2549 sub appDisplayNameFromBundle($)
2550 {
2551     my ($appBundle) = @_;
2552     my $plistPath = File::Spec->rel2abs(plistPathFromBundle($appBundle)); # defaults(1) will complain if the specified path is not absolute.
2553     chomp(my $bundleDisplayName = `defaults read '$plistPath' CFBundleDisplayName 2> /dev/null`);
2554     return $bundleDisplayName;
2555 }
2556
2557 sub waitUntilIOSSimulatorDeviceIsInState($$)
2558 {
2559     my ($deviceUDID, $waitUntilState) = @_;
2560     my $device = iosSimulatorDeviceByUDID($deviceUDID);
2561     # FIXME: We should add a maximum time limit to wait here.
2562     while ($device->{state} ne $waitUntilState) {
2563         usleep(500 * 1000); # Waiting 500ms between file system polls does not make script run-safari feel sluggish.
2564         $device = iosSimulatorDeviceByUDID($deviceUDID);
2565     }
2566 }
2567
2568 sub waitUntilProcessNotRunning($)
2569 {
2570     my ($process) = @_;
2571     while (system("/bin/ps -eo pid,comm | /usr/bin/grep '$process\$'") == 0) {
2572         usleep(500 * 1000);
2573     }
2574 }
2575
2576 sub shutDownIOSSimulatorDevice($)
2577 {
2578     my ($simulatorDevice) = @_;
2579     system("xcrun --sdk iphonesimulator simctl shutdown $simulatorDevice->{UDID} > /dev/null 2>&1");
2580 }
2581
2582 sub restartIOSSimulatorDevice($)
2583 {
2584     my ($simulatorDevice) = @_;
2585     shutDownIOSSimulatorDevice($simulatorDevice);
2586
2587     exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "boot", $simulatorDevice->{UDID})) == 0 or die "Failed to boot simulator device $simulatorDevice->{UDID}";
2588 }
2589
2590 sub relaunchIOSSimulator($)
2591 {
2592     my ($simulatedDevice) = @_;
2593     quitIOSSimulator($simulatedDevice->{UDID});
2594
2595     # FIXME: <rdar://problem/20916140> Switch to using CoreSimulator.framework for launching and quitting iOS Simulator
2596     chomp(my $developerDirectory = $ENV{DEVELOPER_DIR} || `xcode-select --print-path`); 
2597     my $iosSimulatorPath = File::Spec->catfile($developerDirectory, "Applications", "Simulator.app"); 
2598     system("open", "-a", $iosSimulatorPath, "--args", "-CurrentDeviceUDID", $simulatedDevice->{UDID}) == 0 or die "Failed to open $iosSimulatorPath: $!"; 
2599
2600     waitUntilIOSSimulatorDeviceIsInState($simulatedDevice->{UDID}, SIMULATOR_DEVICE_STATE_BOOTED);
2601     waitUntilProcessNotRunning("com.apple.datamigrator");
2602 }
2603
2604 sub quitIOSSimulator(;$)
2605 {
2606     my ($waitForShutdownOfSimulatedDeviceUDID) = @_;
2607     # FIXME: <rdar://problem/20916140> Switch to using CoreSimulator.framework for launching and quitting iOS Simulator
2608     if (exitStatus(system {"osascript"} "osascript", "-e", 'tell application id "com.apple.iphonesimulator" to quit')) {
2609         # osascript returns a non-zero exit status if Simulator.app is not registered in LaunchServices.
2610         return;
2611     }
2612
2613     if (!defined($waitForShutdownOfSimulatedDeviceUDID)) {
2614         return;
2615     }
2616     # FIXME: We assume that $waitForShutdownOfSimulatedDeviceUDID was not booted using the simctl command line tool.
2617     #        Otherwise we will spin indefinitely since quiting the iOS Simulator will not shutdown this device. We
2618     #        should add a maximum time limit to wait for a device to shutdown and either return an error or die()
2619     #        on expiration of the time limit.
2620     waitUntilIOSSimulatorDeviceIsInState($waitForShutdownOfSimulatedDeviceUDID, SIMULATOR_DEVICE_STATE_SHUTDOWN);
2621 }
2622
2623 sub iosSimulatorDeviceByName($)
2624 {
2625     my ($simulatorName) = @_;
2626     my $simulatorRuntime = iosSimulatorRuntime();
2627     my @devices = iOSSimulatorDevices();
2628     for my $device (@devices) {
2629         if ($device->{name} eq $simulatorName && $device->{runtime} eq $simulatorRuntime) {
2630             return $device;
2631         }
2632     }
2633     return undef;
2634 }
2635
2636 sub iosSimulatorDeviceByUDID($)
2637 {
2638     my ($simulatedDeviceUDID) = @_;
2639     my $devicePlistPath = File::Spec->catfile(iOSSimulatorDevicesPath(), $simulatedDeviceUDID, "device.plist");
2640     if (!-f $devicePlistPath) {
2641         return;
2642     }
2643     # FIXME: We should parse the device.plist file ourself and map the dictionary keys in it to known
2644     #        dictionary keys so as to decouple our representation of the plist from the actual structure
2645     #        of the plist, which may change.
2646     eval "require Foundation";
2647     return Foundation::perlRefFromObjectRef(NSDictionary->dictionaryWithContentsOfFile_($devicePlistPath));
2648 }
2649
2650 sub iosSimulatorRuntime()
2651 {
2652     my $xcodeSDKVersion = xcodeSDKVersion();
2653     $xcodeSDKVersion =~ s/\./-/;
2654     return "com.apple.CoreSimulator.SimRuntime.iOS-$xcodeSDKVersion";
2655 }
2656
2657 sub findOrCreateSimulatorForIOSDevice($)
2658 {
2659     my ($simulatorNameSuffix) = @_;
2660     my $simulatorName;
2661     my $simulatorDeviceType;
2662     if (architecture() eq "x86_64") {
2663         $simulatorName = "iPhone SE " . $simulatorNameSuffix;
2664         $simulatorDeviceType = "com.apple.CoreSimulator.SimDeviceType.iPhone-SE";
2665     } else {
2666         $simulatorName = "iPhone 5 " . $simulatorNameSuffix;
2667         $simulatorDeviceType = "com.apple.CoreSimulator.SimDeviceType.iPhone-5";
2668     }
2669     my $simulatedDevice = iosSimulatorDeviceByName($simulatorName);
2670     return $simulatedDevice if $simulatedDevice;
2671     return createiOSSimulatorDevice($simulatorName, $simulatorDeviceType, iosSimulatorRuntime());
2672 }
2673
2674 sub isIOSSimulatorSystemInstalledApp($)
2675 {
2676     my ($appBundle) = @_;
2677     my $simulatorApplicationsPath = realpath(iosSimulatorApplicationsPath());
2678     return substr(realpath($appBundle), 0, length($simulatorApplicationsPath)) eq $simulatorApplicationsPath;
2679 }
2680
2681 sub hasUserInstalledAppInSimulatorDevice($$)
2682 {
2683     my ($appIdentifier, $simulatedDeviceUDID) = @_;
2684     my $userInstalledAppPath = File::Spec->catfile($ENV{HOME}, "Library", "Developer", "CoreSimulator", "Devices", $simulatedDeviceUDID, "data", "Containers", "Bundle", "Application");
2685     if (!-d $userInstalledAppPath) {
2686         return 0; # No user installed apps.
2687     }
2688     local @::userInstalledAppBundles;
2689     my $wantedFunction = sub {
2690         my $file = $_;
2691
2692         # Ignore hidden files and directories.
2693         if ($file =~ /^\../) {
2694             $File::Find::prune = 1;
2695             return;
2696         }
2697
2698         return if !-d $file || $file !~ /\.app$/;
2699         push @::userInstalledAppBundles, $File::Find::name;
2700         $File::Find::prune = 1; # Do not traverse contents of app bundle.
2701     };
2702     find($wantedFunction, $userInstalledAppPath);
2703     for my $userInstalledAppBundle (@::userInstalledAppBundles) {
2704         if (appIdentifierFromBundle($userInstalledAppBundle) eq $appIdentifier) {
2705             return 1; # Has user installed app.
2706         }
2707     }
2708     return 0; # Does not have user installed app.
2709 }
2710
2711 sub isSimulatorDeviceBooted($)
2712 {
2713     my ($simulatedDeviceUDID) = @_;
2714     my $device = iosSimulatorDeviceByUDID($simulatedDeviceUDID);
2715     return $device && $device->{state} eq SIMULATOR_DEVICE_STATE_BOOTED;
2716 }
2717
2718 sub runIOSWebKitAppInSimulator($;$)
2719 {
2720     my ($appBundle, $simulatorOptions) = @_;
2721     my $productDir = productDir();
2722     my $appDisplayName = appDisplayNameFromBundle($appBundle);
2723     my $appIdentifier = appIdentifierFromBundle($appBundle);
2724     my $simulatedDevice = findOrCreateSimulatorForIOSDevice(SIMULATOR_DEVICE_SUFFIX_FOR_WEBKIT_DEVELOPMENT);
2725     my $simulatedDeviceUDID = $simulatedDevice->{UDID};
2726
2727     my $willUseSystemInstalledApp = isIOSSimulatorSystemInstalledApp($appBundle);
2728     if ($willUseSystemInstalledApp) {
2729         if (hasUserInstalledAppInSimulatorDevice($appIdentifier, $simulatedDeviceUDID)) {
2730             # Restore the system-installed app in the simulator device corresponding to $appBundle as it
2731             # was previously overwritten with a custom built version of the app.
2732             # FIXME: Only restore the system-installed version of the app instead of erasing all contents and settings.
2733             print "Quitting iOS Simulator...\n";
2734             quitIOSSimulator($simulatedDeviceUDID);
2735             print "Erasing contents and settings for simulator device \"$simulatedDevice->{name}\".\n";
2736             exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "erase", $simulatedDeviceUDID)) == 0 or die;
2737         }
2738         # FIXME: We assume that if $simulatedDeviceUDID is not booted then iOS Simulator is not open. However
2739         #        $simulatedDeviceUDID may have been booted using the simctl command line tool. If $simulatedDeviceUDID
2740         #        was booted using simctl then we should shutdown the device and launch iOS Simulator to boot it again.
2741         if (!isSimulatorDeviceBooted($simulatedDeviceUDID)) {
2742             print "Launching iOS Simulator...\n";
2743             relaunchIOSSimulator($simulatedDevice);
2744         }
2745     } else {
2746         # FIXME: We should killall(1) any running instances of $appBundle before installing it to ensure
2747         #        that simctl launch opens the latest installed version of the app. For now we quit and
2748         #        launch the iOS Simulator again to ensure there are no running instances of $appBundle.
2749         print "Quitting and launching iOS Simulator...\n";
2750         relaunchIOSSimulator($simulatedDevice);
2751
2752         print "Installing $appBundle.\n";
2753         # Install custom built app, overwriting an app with the same app identifier if one exists.
2754         exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "install", $simulatedDeviceUDID, $appBundle)) == 0 or die;
2755
2756     }
2757
2758     $simulatorOptions = {} unless $simulatorOptions;
2759
2760     my %simulatorENV;
2761     %simulatorENV = %{$simulatorOptions->{applicationEnvironment}} if $simulatorOptions->{applicationEnvironment};
2762     {
2763         local %ENV; # Shadow global-scope %ENV so that changes to it will not be seen outside of this scope.
2764         setupIOSWebKitEnvironment($productDir);
2765         %simulatorENV = %ENV;
2766     }
2767     my $applicationArguments = \@ARGV;
2768     $applicationArguments = $simulatorOptions->{applicationArguments} if $simulatorOptions && $simulatorOptions->{applicationArguments};
2769
2770     # Prefix the environment variables with SIMCTL_CHILD_ per `xcrun simctl help launch`.
2771     foreach my $key (keys %simulatorENV) {
2772         $ENV{"SIMCTL_CHILD_$key"} = $simulatorENV{$key};
2773     }
2774
2775     print "Starting $appDisplayName with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2776     return exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "launch", $simulatedDeviceUDID, $appIdentifier, @$applicationArguments));
2777 }
2778
2779 sub runIOSWebKitApp($)
2780 {
2781     my ($appBundle) = @_;
2782     if (willUseIOSDeviceSDK()) {
2783         die "Only running Safari in iOS Simulator is supported now.";
2784     }
2785     if (willUseIOSSimulatorSDK()) {
2786         return runIOSWebKitAppInSimulator($appBundle);
2787     }
2788     die "Not using an iOS SDK."
2789 }
2790
2791 sub archCommandLineArgumentsForRestrictedEnvironmentVariables()
2792 {
2793     my @arguments = ();
2794     foreach my $key (keys(%ENV)) {
2795         if ($key =~ /^DYLD_/) {
2796             push @arguments, "-e", "$key=$ENV{$key}";
2797         }
2798     }
2799     return @arguments;
2800 }
2801
2802 sub runMacWebKitApp($;$)
2803 {
2804     my ($appPath, $useOpenCommand) = @_;
2805     my $productDir = productDir();
2806     print "Starting @{[basename($appPath)]} with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2807
2808     local %ENV = %ENV;
2809     setupMacWebKitEnvironment($productDir);
2810
2811     if (defined($useOpenCommand) && $useOpenCommand == USE_OPEN_COMMAND) {
2812         return system("open", "-W", "-a", $appPath, "--args", argumentsForRunAndDebugMacWebKitApp());
2813     }
2814     if (architecture()) {
2815         return system "arch", "-" . architecture(), archCommandLineArgumentsForRestrictedEnvironmentVariables(), $appPath, argumentsForRunAndDebugMacWebKitApp();
2816     }
2817     return system { $appPath } $appPath, argumentsForRunAndDebugMacWebKitApp();
2818 }
2819
2820 sub execMacWebKitAppForDebugging($)
2821 {
2822     my ($appPath) = @_;
2823     my $architectureSwitch = "--arch";
2824     my $argumentsSeparator = "--";
2825
2826     my $debuggerPath = `xcrun -find lldb`;
2827     chomp $debuggerPath;
2828     die "Can't find the lldb executable.\n" unless -x $debuggerPath;
2829
2830     my $productDir = productDir();
2831     setupMacWebKitEnvironment($productDir);
2832
2833     my @architectureFlags = ($architectureSwitch, architecture());
2834     print "Starting @{[basename($appPath)]} under lldb with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2835     exec { $debuggerPath } $debuggerPath, @architectureFlags, $argumentsSeparator, $appPath, argumentsForRunAndDebugMacWebKitApp() or die;
2836 }
2837
2838 sub debugSafari
2839 {
2840     if (isAppleMacWebKit()) {
2841         checkFrameworks();
2842         execMacWebKitAppForDebugging(safariPath());
2843     }
2844
2845     return 1; # Unsupported platform; can't debug Safari on this platform.
2846 }
2847
2848 sub runSafari
2849 {
2850     if (isIOSWebKit()) {
2851         return runIOSWebKitApp(mobileSafariBundle());
2852     }
2853
2854     if (isAppleMacWebKit()) {
2855         return runMacWebKitApp(safariPath());
2856     }
2857
2858     if (isAppleWinWebKit()) {
2859         my $result;
2860         my $webKitLauncherPath = File::Spec->catfile(executableProductDir(), "MiniBrowser.exe");
2861         return system { $webKitLauncherPath } $webKitLauncherPath, @ARGV;
2862     }
2863
2864     return 1; # Unsupported platform; can't run Safari on this platform.
2865 }
2866
2867 sub runMiniBrowser
2868 {
2869     if (isAppleMacWebKit()) {
2870         return runMacWebKitApp(File::Spec->catfile(productDir(), "MiniBrowser.app", "Contents", "MacOS", "MiniBrowser"));
2871     }
2872     if (isAppleWinWebKit()) {
2873         my $webKitLauncherPath = File::Spec->catfile(executableProductDir(), "MiniBrowser.exe");
2874         return system { $webKitLauncherPath } $webKitLauncherPath, @ARGV;
2875     }
2876     return 1;
2877 }
2878
2879 sub debugMiniBrowser
2880 {
2881     if (isAppleMacWebKit()) {
2882         execMacWebKitAppForDebugging(File::Spec->catfile(productDir(), "MiniBrowser.app", "Contents", "MacOS", "MiniBrowser"));
2883     }
2884     
2885     return 1;
2886 }
2887
2888 sub runWebKitTestRunner
2889 {
2890     if (isAppleMacWebKit()) {
2891         return runMacWebKitApp(File::Spec->catfile(productDir(), "WebKitTestRunner"));
2892     }
2893
2894     return 1;
2895 }
2896
2897 sub debugWebKitTestRunner
2898 {
2899     if (isAppleMacWebKit()) {
2900         execMacWebKitAppForDebugging(File::Spec->catfile(productDir(), "WebKitTestRunner"));
2901     }
2902
2903     return 1;
2904 }
2905
2906 sub readRegistryString
2907 {
2908     my ($valueName) = @_;
2909     chomp(my $string = `regtool --wow32 get "$valueName"`);
2910     return $string;
2911 }
2912
2913 sub writeRegistryString
2914 {
2915     my ($valueName, $string) = @_;
2916
2917     my $error = system "regtool", "--wow32", "set", "-s", $valueName, $string;
2918
2919     # On Windows Vista/7 with UAC enabled, regtool will fail to modify the registry, but will still
2920     # return a successful exit code. So we double-check here that the value we tried to write to the
2921     # registry was really written.
2922     return !$error && readRegistryString($valueName) eq $string;
2923 }
2924
2925 sub formatBuildTime($)
2926 {
2927     my ($buildTime) = @_;
2928
2929     my $buildHours = int($buildTime / 3600);
2930     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
2931     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
2932
2933     if ($buildHours) {
2934         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
2935     }
2936     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
2937 }
2938
2939 sub runSvnUpdateAndResolveChangeLogs(@)
2940 {
2941     my @svnOptions = @_;
2942     my $openCommand = "svn update " . join(" ", @svnOptions);
2943     open my $update, "$openCommand |" or die "cannot execute command $openCommand";
2944     my @conflictedChangeLogs;
2945     while (my $line = <$update>) {
2946         print $line;
2947         $line =~ m/^C\s+(.+?)[\r\n]*$/;
2948         if ($1) {
2949           my $filename = normalizePath($1);
2950           push @conflictedChangeLogs, $filename if basename($filename) eq "ChangeLog";
2951         }
2952     }
2953     close $update or die;
2954
2955     if (@conflictedChangeLogs) {
2956         print "Attempting to merge conflicted ChangeLogs.\n";
2957         my $resolveChangeLogsPath = File::Spec->catfile(sourceDir(), "Tools", "Scripts", "resolve-ChangeLogs");
2958         (system($resolveChangeLogsPath, "--no-warnings", @conflictedChangeLogs) == 0)
2959             or die "Could not open resolve-ChangeLogs script: $!.\n";
2960     }
2961 }
2962
2963 sub runGitUpdate()
2964 {
2965     # Doing a git fetch first allows setups with svn-remote.svn.fetch = trunk:refs/remotes/origin/master
2966     # to perform the rebase much much faster.
2967     system("git", "fetch");
2968     if (isGitSVNDirectory(".")) {
2969         system("git", "svn", "rebase") == 0 or die;
2970     } else {
2971         # This will die if branch.$BRANCHNAME.merge isn't set, which is
2972         # almost certainly what we want.
2973         system("git", "pull") == 0 or die;
2974     }
2975 }
2976
2977 1;