This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
If there is no 'blead' branch, bisect.pl now uses a suitable alternative.
[perl5.git] / Porting / bisect.pl
index 611e34a..db08f4c 100755 (executable)
 #!/usr/bin/perl -w
 use strict;
 
-my $start_time = time;
+=for comment
+
+Documentation for this is in bisect-runner.pl
+
+=cut
 
 # The default, auto_abbrev will treat -e as an abbreviation of --end
 # Which isn't what we want.
 use Getopt::Long qw(:config pass_through no_auto_abbrev);
 
-sub usage {
-    die "$0: [--start revlike] [--end revlike] [--target=...] [-j4] [--expect-pass=0|1] thing to test";
+my ($start, $end, $validate, $usage, $bad, $jobs, $make, $gold);
+$bad = !GetOptions('start=s' => \$start, 'end=s' => \$end,
+                   'jobs|j=i' => \$jobs, 'make=s' => \$make, 'gold=s' => \$gold,
+                   validate => \$validate, 'usage|help|?' => \$usage);
+unshift @ARGV, '--help' if $bad || $usage;
+unshift @ARGV, '--validate' if $validate;
+
+my $runner = $0;
+$runner =~ s/bisect\.pl/bisect-runner.pl/;
+
+die "Can't find bisect runner $runner" unless -f $runner;
+
+system $^X, $runner, '--check-args', '--check-shebang', @ARGV and exit 255;
+exit 255 if $bad;
+exit 0 if $usage;
+
+{
+    my ($dev0, $ino0) = stat $0;
+    die "Can't stat $0: $!" unless defined $ino0;
+    my ($dev1, $ino1) = stat 'Porting/bisect.pl';
+    die "Can't run a bisect using the directory containing $runner"
+      if defined $dev1 && $dev0 == $dev1 && $ino0 == $ino1;
 }
 
-my ($start, $end);
-unless(GetOptions('start=s' => \$start,
-                  'end=s' => \$end,
-                 )) {
-    usage();
+my $start_time = time;
+
+if (!defined $jobs &&
+    !($^O eq 'hpux' && system((defined $make ? $make : 'make')
+                              . ' --version >/dev/null 2>&1'))) {
+    # Try to default to (ab)use all the CPUs:
+    my $cpus;
+    if (open my $fh, '<', '/proc/cpuinfo') {
+        while (<$fh>) {
+            ++$cpus if /^processor\s+:\s+\d+$/;
+        }
+    } elsif (-x '/sbin/sysctl') {
+        $cpus =  $1 if `/sbin/sysctl hw.ncpu` =~ /^hw\.ncpu: (\d+)$/;
+    } elsif (-x '/usr/bin/getconf') {
+        $cpus = $1 if `/usr/bin/getconf _NPROCESSORS_ONLN` =~ /^(\d+)$/;
+    }
+    $jobs = defined $cpus ? $cpus + 1 : 2;
 }
 
+unshift @ARGV, '--jobs', $jobs if defined $jobs;
+unshift @ARGV, '--make', $make if defined $make;
+
 # We try these in this order for the start revision if none is specified.
-my @stable = qw(perl-5.002 perl-5.003 perl-5.004 perl-5.005 perl-5.6.0
-                perl-5.8.0 v5.10.0 v5.12.0 v5.14.0);
+my @stable = map {chomp $_; $_} grep {/v5\.[0-9]+[02468]\.0$/} `git tag -l`;
+die "git tag -l didn't seem to return any tags for stable releases"
+    unless @stable;
+unshift @stable, qw(perl-5.005 perl-5.6.0 perl-5.8.0);
+
+{
+    my ($dev_C, $ino_C) = stat 'Configure';
+    my ($dev_c, $ino_c) = stat 'configure';
+    if (defined $dev_C && defined $dev_c
+        && $dev_C == $dev_c && $ino_C == $ino_c) {
+        print "You seem to be on a case-insensitive file system.\n\n";
+    } else {
+        unshift @stable, qw(perl-5.002 perl-5.003 perl-5.004)
+    }
+}
 
-if ($start) {
-    system "git rev-parse $start >/dev/null" and die;
+unshift @ARGV, '--gold', defined $gold ? $gold : $stable[-1];
+
+if (!defined $end) {
+    # If we have a branch blead, use that as the end
+    $end = `git rev-parse --verify --quiet blead`;
+    die unless defined $end;
+    if (!length $end) {
+        # Else use whichever is newer - HEAD, or the most recent stable tag.
+        if (`git rev-list -n1 HEAD ^$stable[-1]` eq "") {
+            $end = pop @stable;
+        } else {
+            $end = 'HEAD';
+        }
+    }
 }
-$end = 'blead' unless defined $end;
-system "git rev-parse $end >/dev/null" and die;
 
-my $modified = () = `git ls-files --modified --deleted --others`;
+# Canonicalising branches to revisions before moving the checkout permits one
+# to use revisions such as 'HEAD' for --start or --end
+foreach ($start, $end) {
+    next unless $_;
+    $_ = `git rev-parse $_`;
+    die unless defined $_;
+    chomp;
+}
 
-die "This checkout is not clean - $modified modified or untracked file(s)"
+my $modified = my @modified = `git ls-files --modified --deleted --others`;
+
+die "This checkout is not clean, found file(s):\n",
+    join("\t","",@modified),
+    "$modified modified, untracked, or other file(s)\n",
+    "These files may not show in git status as they may be ignored.\n",
+    "You can use 'git clean -Xdf' to cleanup the ignored files.\n"
     if $modified;
 
-system "git bisect reset" and die;
+sub validate {
+    my $commit = shift;
+    if (defined $start && `git rev-list -n1 $commit ^$start^` eq "") {
+        print "Skipping $commit, as it is earlier than $start\n";
+        return;
+    }
+    if (defined $end && `git rev-list -n1 $end ^$commit^` eq "") {
+        print "Skipping $commit, as it is more recent than $end\n";
+        return;
+    }
+    print "Testing $commit...\n";
+    system "git checkout $commit </dev/null" and die;
+    my $ret = system $^X, $runner, '--no-clean', @ARGV;
+    die "Runner returned $ret, not 0 for revision $commit" if $ret;
+    system 'git clean -dxf </dev/null' and die;
+    system 'git reset --hard HEAD </dev/null' and die;
+    return $commit;
+}
 
-my $runner = $0;
-$runner =~ s/bisect\.pl/bisect-runner.pl/;
+if ($validate) {
+    require Text::Wrap;
+    my @built = map {validate $_} 'blead', reverse @stable;
+    if (@built) {
+        print Text::Wrap::wrap("", "", "Successfully validated @built\n");
+        exit 0;
+    }
+    print "Did not validate anything\n";
+    exit 1;
+}
 
-die "Can't find bisect runner $runner" unless -f $runner;
+my $git_version = `git --version`;
+if (defined $git_version
+    && $git_version =~ /\Agit version (\d+\.\d+\.\d+)(.*)/) {
+    $git_version = eval "v$1";
+} else {
+    $git_version = v0.0.0;
+}
 
-system $^X, $runner, '--check-args', @ARGV and exit 255;
+if ($git_version ge v1.6.6) {
+    system "git bisect reset HEAD" and die;
+} else {
+    system "git bisect reset" and die;
+}
 
 # Sanity check the first and last revisions:
+system "git checkout $end" and die;
+my $ret = system $^X, $runner, @ARGV;
+die "Runner returned $ret for end revision" unless $ret;
+die "Runner returned $ret for end revision, which is a skip"
+    if $ret == 125 * 256;
+
 if (defined $start) {
     system "git checkout $start" and die;
     my $ret = system $^X, $runner, @ARGV;
     die "Runner returned $ret, not 0 for start revision" if $ret;
 } else {
     # Try to find the earliest version for which the test works
+    my @tried;
     foreach my $try (@stable) {
+        if (`git rev-list -n1 $end ^$try^` eq "") {
+            print "Skipping $try, as it is more recent than end commit "
+                . (substr $end, 0, 16) . "\n";
+            # As @stable is supposed to be in age order, arguably we should
+            # last; here.
+            next;
+        }
         system "git checkout $try" and die;
         my $ret = system $^X, $runner, @ARGV;
         if (!$ret) {
             $start = $try;
             last;
         }
+        push @tried, $try;
     }
-    die "Can't find a suitable start revision to default to. Tried @stable"
+    die "Can't find a suitable start revision to default to.\nTried @tried"
         unless defined $start;
 }
-system "git checkout $end" and die;
-my $ret = system $^X, $runner, @ARGV;
-die "Runner returned $ret for end revision" unless $ret;
 
 system "git bisect start" and die;
 system "git bisect good $start" and die;
@@ -78,6 +200,12 @@ END {
         if defined $start_time;
 }
 
+=for comment
+
+Documentation for this is in bisect-runner.pl
+
+=cut
+
 # Local variables:
 # cperl-indent-level: 4
 # indent-tabs-mode: nil