| # Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved |
| # Copyright (C) 2006 Alexey Proskuryakov (ap@nypop.com) |
| # Copyright (C) 2010 Andras Becsi (abecsi@inf.u-szeged.hu), University of Szeged |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions |
| # are met: |
| # |
| # 1. Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # 2. Redistributions in binary form must reproduce the above copyright |
| # notice, this list of conditions and the following disclaimer in the |
| # documentation and/or other materials provided with the distribution. |
| # 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of |
| # its contributors may be used to endorse or promote products derived |
| # from this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY |
| # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY |
| # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| # Module to share code to start and stop the Apache daemon. |
| |
| use strict; |
| use warnings; |
| |
| use File::Path; |
| use File::Spec; |
| use File::Spec::Functions; |
| use Fcntl ':flock'; |
| use IPC::Open2; |
| |
| use webkitdirs; |
| |
| BEGIN { |
| use Exporter (); |
| our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS); |
| $VERSION = 1.00; |
| @ISA = qw(Exporter); |
| @EXPORT = qw(&getHTTPDPath |
| &getHTTPDConfigPathForTestDirectory |
| &getDefaultConfigForTestDirectory |
| &openHTTPD |
| &closeHTTPD |
| &setShouldWaitForUserInterrupt |
| &waitForHTTPDLock |
| &getWaitTime); |
| %EXPORT_TAGS = ( ); |
| @EXPORT_OK = (); |
| } |
| |
| my $tmpDir = "/tmp"; |
| my $httpdLockPrefix = "WebKitHttpd.lock."; |
| my $myLockFile; |
| my $exclusiveLockFile = File::Spec->catfile($tmpDir, "WebKit.lock"); |
| my $httpdPath; |
| my $httpdPidDir = File::Spec->catfile($tmpDir, "WebKit"); |
| my $httpdPidFile = File::Spec->catfile($httpdPidDir, "httpd.pid"); |
| my $httpdPid; |
| my $waitForUserInterrupt = 0; |
| my $waitBeginTime; |
| my $waitEndTime; |
| |
| $SIG{'INT'} = 'handleInterrupt'; |
| $SIG{'TERM'} = 'handleInterrupt'; |
| |
| sub getHTTPDPath |
| { |
| if (isDebianBased()) { |
| $httpdPath = "/usr/sbin/apache2"; |
| } else { |
| $httpdPath = "/usr/sbin/httpd"; |
| } |
| return $httpdPath; |
| } |
| |
| sub getDefaultConfigForTestDirectory |
| { |
| my ($testDirectory) = @_; |
| die "No test directory has been specified." unless ($testDirectory); |
| |
| my $httpdConfig = getHTTPDConfigPathForTestDirectory($testDirectory); |
| my $documentRoot = "$testDirectory/http/tests"; |
| my $jsTestResourcesDirectory = $testDirectory . "/fast/js/resources"; |
| my $typesConfig = "$testDirectory/http/conf/mime.types"; |
| my $httpdLockFile = File::Spec->catfile($httpdPidDir, "httpd.lock"); |
| my $httpdScoreBoardFile = File::Spec->catfile($httpdPidDir, "httpd.scoreboard"); |
| |
| my @httpdArgs = ( |
| "-f", "$httpdConfig", |
| "-C", "DocumentRoot \"$documentRoot\"", |
| # Setup a link to where the js test templates are stored, use -c so that mod_alias will already be loaded. |
| "-c", "Alias /js-test-resources \"$jsTestResourcesDirectory\"", |
| "-c", "TypesConfig \"$typesConfig\"", |
| # Apache wouldn't run CGIs with permissions==700 otherwise |
| "-c", "User \"#$<\"", |
| "-c", "LockFile \"$httpdLockFile\"", |
| "-c", "PidFile \"$httpdPidFile\"", |
| "-c", "ScoreBoardFile \"$httpdScoreBoardFile\"", |
| ); |
| |
| # FIXME: Enable this on Windows once <rdar://problem/5345985> is fixed |
| # The version of Apache we use with Cygwin does not support SSL |
| my $sslCertificate = "$testDirectory/http/conf/webkit-httpd.pem"; |
| push(@httpdArgs, "-c", "SSLCertificateFile \"$sslCertificate\"") unless isCygwin(); |
| |
| return @httpdArgs; |
| |
| } |
| |
| sub getHTTPDConfigPathForTestDirectory |
| { |
| my ($testDirectory) = @_; |
| die "No test directory has been specified." unless ($testDirectory); |
| my $httpdConfig; |
| getHTTPDPath(); |
| if (isCygwin()) { |
| my $windowsConfDirectory = "$testDirectory/http/conf/"; |
| unless (-x "/usr/lib/apache/libphp4.dll") { |
| copy("$windowsConfDirectory/libphp4.dll", "/usr/lib/apache/libphp4.dll"); |
| chmod(0755, "/usr/lib/apache/libphp4.dll"); |
| } |
| $httpdConfig = "$windowsConfDirectory/cygwin-httpd.conf"; |
| } elsif (isDebianBased()) { |
| $httpdConfig = "$testDirectory/http/conf/apache2-debian-httpd.conf"; |
| } elsif (isFedoraBased()) { |
| $httpdConfig = "$testDirectory/http/conf/fedora-httpd.conf"; |
| } else { |
| $httpdConfig = "$testDirectory/http/conf/httpd.conf"; |
| $httpdConfig = "$testDirectory/http/conf/apache2-httpd.conf" if `$httpdPath -v` =~ m|Apache/2|; |
| } |
| return $httpdConfig; |
| } |
| |
| sub openHTTPD(@) |
| { |
| my (@args) = @_; |
| die "No HTTPD configuration has been specified" unless (@args); |
| mkdir($httpdPidDir, 0755); |
| die "No write permissions to $httpdPidDir" unless (-w $httpdPidDir); |
| |
| if (-f $httpdPidFile) { |
| open (PIDFILE, $httpdPidFile); |
| my $oldPid = <PIDFILE>; |
| chomp $oldPid; |
| close PIDFILE; |
| if (0 != kill 0, $oldPid) { |
| print "\nhttpd is already running: pid $oldPid, killing...\n"; |
| kill 15, $oldPid; |
| |
| my $retryCount = 20; |
| while ((kill(0, $oldPid) != 0) && $retryCount) { |
| sleep 1; |
| --$retryCount; |
| } |
| |
| if (!$retryCount) { |
| cleanUp(); |
| die "Timed out waiting for httpd to quit"; |
| } |
| } |
| } |
| |
| $httpdPath = "/usr/sbin/httpd" unless ($httpdPath); |
| |
| open2(">&1", \*HTTPDIN, $httpdPath, @args); |
| |
| my $retryCount = 20; |
| while (!-f $httpdPidFile && $retryCount) { |
| sleep 1; |
| --$retryCount; |
| } |
| |
| if (!$retryCount) { |
| cleanUp(); |
| die "Timed out waiting for httpd to start"; |
| } |
| |
| $httpdPid = <PIDFILE> if open(PIDFILE, $httpdPidFile); |
| chomp $httpdPid if $httpdPid; |
| close PIDFILE; |
| |
| waitpid($httpdPid, 0) if ($waitForUserInterrupt && $httpdPid); |
| |
| return 1; |
| } |
| |
| sub closeHTTPD |
| { |
| close HTTPDIN; |
| my $retryCount = 20; |
| if ($httpdPid) { |
| kill 15, $httpdPid; |
| while (-f $httpdPidFile && $retryCount) { |
| sleep 1; |
| --$retryCount; |
| } |
| } |
| cleanUp(); |
| if (!$retryCount) { |
| print STDERR "Timed out waiting for httpd to terminate!\n"; |
| return 0; |
| } |
| return 1; |
| } |
| |
| sub setShouldWaitForUserInterrupt |
| { |
| $waitForUserInterrupt = 1; |
| } |
| |
| sub handleInterrupt |
| { |
| closeHTTPD(); |
| print "\n"; |
| exit(1); |
| } |
| |
| sub cleanUp |
| { |
| rmdir $httpdPidDir; |
| unlink $exclusiveLockFile; |
| unlink $myLockFile if $myLockFile; |
| } |
| |
| sub extractLockNumber |
| { |
| my ($lockFile) = @_; |
| return -1 unless $lockFile; |
| return substr($lockFile, length($httpdLockPrefix)); |
| } |
| |
| sub getLockFiles |
| { |
| opendir(TMPDIR, $tmpDir) or die "Could not open " . $tmpDir . "."; |
| my @lockFiles = grep {m/^$httpdLockPrefix\d+$/} readdir(TMPDIR); |
| @lockFiles = sort { extractLockNumber($a) <=> extractLockNumber($b) } @lockFiles; |
| closedir(TMPDIR); |
| return @lockFiles; |
| } |
| |
| sub getNextAvailableLockNumber |
| { |
| my @lockFiles = getLockFiles(); |
| return 0 unless @lockFiles; |
| return extractLockNumber($lockFiles[-1]) + 1; |
| } |
| |
| sub getLockNumberForCurrentRunning |
| { |
| my @lockFiles = getLockFiles(); |
| return 0 unless @lockFiles; |
| return extractLockNumber($lockFiles[0]); |
| } |
| |
| sub waitForHTTPDLock |
| { |
| $waitBeginTime = time; |
| scheduleHttpTesting(); |
| # If we are the only one waiting for Apache just run the tests without any further checking |
| if (scalar getLockFiles() > 1) { |
| my $currentLockFile = File::Spec->catfile($tmpDir, "$httpdLockPrefix" . getLockNumberForCurrentRunning()); |
| my $currentLockPid = <SCHEDULER_LOCK> if (-f $currentLockFile && open(SCHEDULER_LOCK, "<$currentLockFile")); |
| # Wait until we are allowed to run the http tests |
| while ($currentLockPid && $currentLockPid != $$) { |
| $currentLockFile = File::Spec->catfile($tmpDir, "$httpdLockPrefix" . getLockNumberForCurrentRunning()); |
| if ($currentLockFile eq $myLockFile) { |
| $currentLockPid = <SCHEDULER_LOCK> if open(SCHEDULER_LOCK, "<$currentLockFile"); |
| if ($currentLockPid != $$) { |
| print STDERR "\nPID mismatch.\n"; |
| last; |
| } |
| } else { |
| sleep 1; |
| } |
| } |
| } |
| $waitEndTime = time; |
| } |
| |
| sub scheduleHttpTesting |
| { |
| # We need an exclusive lock file to avoid deadlocks and starvation and ensure that the scheduler lock numbers are sequential. |
| # The scheduler locks are used to schedule the running test sessions in first come first served order. |
| while (!(open(SEQUENTIAL_GUARD_LOCK, ">$exclusiveLockFile") && flock(SEQUENTIAL_GUARD_LOCK, LOCK_EX|LOCK_NB))) {} |
| $myLockFile = File::Spec->catfile($tmpDir, "$httpdLockPrefix" . getNextAvailableLockNumber()); |
| open(SCHEDULER_LOCK, ">$myLockFile"); |
| print SCHEDULER_LOCK "$$"; |
| print SEQUENTIAL_GUARD_LOCK "$$"; |
| close(SCHEDULER_LOCK); |
| close(SEQUENTIAL_GUARD_LOCK); |
| unlink $exclusiveLockFile; |
| } |
| |
| sub getWaitTime |
| { |
| my $waitTime = 0; |
| if ($waitBeginTime && $waitEndTime) { |
| $waitTime = $waitEndTime - $waitBeginTime; |
| } |
| return $waitTime; |
| } |
