use strict;
use Getopt::Long qw(:config bundling no_auto_abbrev);
+use Pod::Usage;
+use Config;
-my @targets = qw(config.sh config.h miniperl lib/Config.pm perl test_prep);
+my @targets
+ = qw(config.sh config.h miniperl lib/Config.pm Fcntl perl test_prep);
+
+my $cpus;
+if (open my $fh, '<', '/proc/cpuinfo') {
+ while (<$fh>) {
+ ++$cpus if /^processor\s+:\s+\d+$/;
+ }
+} elsif (-x '/sbin/sysctl') {
+ $cpus = 1 + $1 if `/sbin/sysctl hw.ncpu` =~ /^hw\.ncpu: (\d+)$/;
+}
my %options =
(
- jobs => 9,
+ jobs => defined $cpus ? $cpus + 1 : 2,
'expect-pass' => 1,
clean => 1, # mostly for debugging this
);
optimize => '-g',
cc => 'ccache gcc',
ld => 'gcc',
- 'libpth' => \@paths,
+ (`uname -sm` eq "Linux x86_64\n" ? (libpth => \@paths) : ()),
);
-sub usage {
- die "$0: [--target=...] [-j4] [--expect-pass=0|1] thing to test";
-}
-
unless(GetOptions(\%options,
'target=s', 'jobs|j=i', 'expect-pass=i',
'expect-fail' => sub { $options{'expect-pass'} = 0; },
'clean!', 'one-liner|e=s', 'match=s', 'force-manifest',
- 'test-build', 'check-args', 'A=s@', 'verbose+',
+ 'test-build', 'check-args', 'A=s@', 'usage|help|?',
'D=s@' => sub {
my (undef, $val) = @_;
if ($val =~ /\A([^=]+)=(.*)/s) {
$defines{$_[1]} = undef;
},
)) {
- usage();
+ pod2usage(exitval => 255, verbose => 1);
}
my ($target, $j, $match) = @options{qw(target jobs match)};
-usage() unless @ARGV || $match || $options{'test-build'}
- || defined $options{'one-liner'};
+pod2usage(exitval => 255, verbose => 1) if $options{usage};
+pod2usage(exitval => 255, verbose => 1)
+ unless @ARGV || $match || $options{'test-build'} || defined $options{'one-liner'};
exit 0 if $options{'check-args'};
+=head1 NAME
+
+bisect.pl - use git bisect to pinpoint changes
+
+=head1 SYNOPSIS
+
+ # When did this become an error?
+ .../Porting/bisect.pl -e 'my $a := 2;'
+ # When did this stop being an error?
+ .../Porting/bisect.pl --expect-fail -e '1 // 2'
+ # When did this stop matching?
+ .../Porting/bisect.pl --match '\b(?:PL_)hash_seed_set\b'
+ # When did this start matching?
+ .../Porting/bisect.pl --expect-fail --match '\buseithreads\b'
+ # When did this test program stop working?
+ .../Porting/bisect.pl --target=perl -- ./perl -Ilib test_prog.pl
+ # When did this first become valid syntax?
+ .../Porting/bisect.pl --target=miniperl --end=v5.10.0 \
+ --expect-fail -e 'my $a := 2;'
+ # What was the last revision to build with these options?
+ .../Porting/bisect.pl --test-build -Dd_dosuid
+
+=head1 DESCRIPTION
+
+Together C<bisect.pl> and C<bisect-runner.pl> attempt to automate the use
+of C<git bisect> as much as possible. With one command (and no other files)
+it's easy to find out
+
+=over 4
+
+=item *
+
+Which commit caused this example code to break?
+
+=item *
+
+Which commit caused this example code to start working?
+
+=item *
+
+Which commit added the first to match this regex?
+
+=item *
+
+Which commit removed the last to match this regex?
+
+=back
+
+usually without needing to know which versions of perl to use as start and
+end revisions.
+
+By default C<bisect.pl> will process all options, then use the rest of the
+command line as arguments to list C<system> to run a test case. By default,
+the test case should pass (exit with 0) on earlier perls, and fail (exit
+non-zero) on I<blead>. C<bisect.pl> will use C<bisect-runner.pl> to find the
+earliest stable perl version on which the test case passes, check that it
+fails on blead, and then use C<bisect-runner.pl> with C<git bisect run> to
+find the commit which caused the failure.
+
+Because the test case is the complete argument to C<system>, it is easy to
+run something other than the F<perl> built, if necessary. If you need to run
+the perl built, you'll probably need to invoke it as C<./perl -Ilib ...>
+
+=head1 OPTIONS
+
+=over 4
+
+=item *
+
+--start I<commit-ish>
+
+Earliest revision to test, as a I<commit-ish> (a tag, commit or anything
+else C<git> understands as a revision). If not specified, C<bisect.pl> will
+search stable perl releases from 5.002 to 5.14.0 until it finds one where
+the test case passes.
+
+=item *
+
+--end I<commit-ish>
+
+Most recent revision to test, as a I<commit-ish>. If not specified, defaults
+to I<blead>
+
+=item *
+
+--target I<target>
+
+F<Makefile> target (or equivalent) needed, to run the test case. If specified,
+this should be one of
+
+=over 4
+
+=item *
+
+I<config.sh>
+
+Just run C<Configure>
+
+=item *
+
+I<config.h>
+
+Run the various F<*.SH> files to generate F<Makefile>, F<config.h>, I<etc>.
+
+=item *
+
+I<miniperl>
+
+Build F<miniperl>.
+
+=item *
+
+I<lib/Config.pm>
+
+Use F<miniperl> to build F<lib/Config.pm>
+
+=item *
+
+I<Fcntl>
+
+Build F<lib/auto/Fcntl/Fnctl.so> (strictly, C<.$Config{so}>). As L<Fcntl>
+is simple XS module present since 5.000, this provides a fast test of
+whether XS modules can be build. Note, XS modules are built by F<miniperl>,
+hence this target will not build F<perl>.
+
+=item *
+
+I<perl>
+
+Build F<perl>. This also builds pure-Perl modules in F<cpan>, F<dist> and
+F<ext>. XS modules (such as L<Fcntl>) are not built.
+
+=item *
+
+I<perl>
+
+=item *
+
+I<test_prep>
+
+Build everything needed to run the tests. This is the default if we're
+running test code, but is time consuming, as it means building all
+C<XS> modules. For older F<Makefile>s, the previous name of C<test-prep>
+is automatically substituted. For very old F<Makefile>s, C<make test> is
+run, as there is no target provided to just get things ready, and for 5.004
+and earlier the tests run very quickly.
+
+=back
+
+=item *
+
+--one-liner 'code to run'
+
+=item *
+
+-e 'code to run'
+
+Example code to run, just like you'd use with C<perl -e>.
+
+This prepends C<./perl -Ilib -e 'code to run'> to the test case given,
+or C<./miniperl> if I<target> is C<miniperl>
+
+(Usually you'll use C<-e> instead of providing a test case in the
+non-option arguments to C<bisect.pl>)
+
+C<-E> intentionally isn't supported, as it's an error in 5.8.0 and earlier,
+which interferes with detecting errors in the example code itself.
+
+=item *
+
+--expect-fail
+
+The test case should fail for the I<start> revision, and pass for the I<end>
+revision. The bisect run will find the first commit where it passes.
+
+=item *
+
+-Dusethreads
+
+=item *
+
+-Uusedevel
+
+=item *
+
+-Accflags=-DNO_MATHOMS
+
+Arguments to pass to F<Configure>. Repeated C<-A> arguments are passed
+through as is. C<-D> and C<-U> are processed in order, and override
+previous settings for the same parameter.
+
+=item *
+
+--jobs
+
+=item *
+
+-j
+
+Number of C<make> jobs to run in parallel. If F</proc/cpuinfo> exists and can
+be parsed, or F</sbin/sysctl> exists and reports <hw.ncpu>, defaults to
+1 + I<number of CPUs>. Otherwise defaults to 2.
+
+=item *
+
+--match
+
+Instead of running a test program to determine I<pass> or I<fail>, pass
+if the given regex matches, and hence search for the commit that removes
+the last matching file.
+
+If no I<target> is specified, the match is against all files in the
+repository (which is fast). If a I<target> is specified, that target is
+built, and the match is against only the built files. C<--expect-fail> can
+be used with C<--match> to search for a commit that adds files that match.
+
+=item *
+
+--test-build
+
+Test that the build completes, without running any test case.
+
+By default, if the build for the desired I<target> fails to complete,
+F<bisect-runner.pl> reports a I<skip> back to C<git bisect>, the assumption
+being that one wants to find a commit which changed state "builds && passes"
+to "builds && fails". If instead one is interested in which commit broke the
+build (possibly for particular F<Configure> options), use I<--test-build>
+to treat a build failure as a failure, not a "skip".
+
+=item *
+
+By default, a build will "skip" if any files listed in F<MANIFEST> are not
+present. Usually this is useful, as it avoids false-failures. However, there
+are some long ranges of commits where listed files are missing, which can
+cause a bisect to abort because all that remain are skipped revisions.
+
+In these cases, particularly if the test case uses F<miniperl> and no modules,
+it may be more useful to force the build to continue, even if files
+F<MANIFEST> are missing.
+
+=item *
+
+--expect-pass [0|1]
+
+C<--expect-pass=0> is equivalent to C<--expect-fail>. I<1> is the default.
+
+=item *
+
+--no-clean
+
+Tell F<bisect-runner.pl> not to clean up after the build. This allows one
+to use F<bisect-runner.pl> to build the current particular perl revision for
+interactive testing, or for debugging F<bisect-runner.pl>.
+
+Passing this to F<bisect.pl> will likely cause the bisect to fail badly.
+
+=item *
+
+--check-args
+
+Validate the options and arguments, and exit silently if they are valid.
+
+=item *
+
+--usage
+
+=item *
+
+--help
+
+=item *
+
+-?
+
+Display the usage information and exit.
+
+=back
+
+=cut
+
die "$0: Can't build $target" if defined $target && !grep {@targets} $target;
$j = "-j$j" if $j =~ /\A\d+\z/;
my $patch = shift;
my ($file) = $patch =~ qr!^diff.*a/(\S+) b/\1!;
- open my $fh, '|-', 'patch' or die "Can't run patch: $!";
+ open my $fh, '|-', 'patch', '-p1' or die "Can't run patch: $!";
print $fh $patch;
close $fh or die "Can't patch $file: $?, $!";
}
EOPATCH
}
}
+
+if ($major < 10 && extract_from_file('Configure', qr/^set malloc\.h i_malloc$/)) {
+ # This is commit 01d07975f7ef0e7d, trimmed, with $compile inlined as
+ # prior to bd9b35c97ad661cc Configure had the malloc.h test before the
+ # definition of $compile.
+ apply_patch(<<'EOPATCH');
+diff --git a/Configure b/Configure
+index 3d2e8b9..6ce7766 100755
+--- a/Configure
++++ b/Configure
+@@ -6743,5 +6743,22 @@ set d_dosuid
+
+ : see if this is a malloc.h system
+-set malloc.h i_malloc
+-eval $inhdr
++: we want a real compile instead of Inhdr because some systems have a
++: malloc.h that just gives a compile error saying to use stdlib.h instead
++echo " "
++$cat >try.c <<EOCP
++#include <stdlib.h>
++#include <malloc.h>
++int main () { return 0; }
++EOCP
++set try
++if $cc $optimize $ccflags $ldflags -o try $* try.c $libs > /dev/null 2>&1; then
++ echo "<malloc.h> found." >&4
++ val="$define"
++else
++ echo "<malloc.h> NOT found." >&4
++ val="$undef"
++fi
++$rm -f try.c try
++set i_malloc
++eval $setvar
+
+EOPATCH
+}
# There was a bug in makedepend.SH which was fixed in version 96a8704c.
# Symptom was './makedepend: 1: Syntax error: Unterminated quoted string'
# Remove this if you're actually bisecting a problem related to makedepend.SH
system 'git show blead:makedepend.SH > makedepend.SH' and die;
+if ($^O eq 'freebsd') {
+ # There are rather too many version-specific FreeBSD hints fixes to patch
+ # individually. Also, more than once the FreeBSD hints file has been
+ # written in what turned out to be a rather non-future-proof style,
+ # with case statements treating the most recent version as the exception,
+ # instead of treating previous versions' behaviour explicitly and changing
+ # the default to cater for the current behaviour. (As strangely, future
+ # versions inherit the current behaviour.)
+ system 'git show blead:hints/freebsd.sh > hints/freebsd.sh' and die;
+
+ if ($major < 2) {
+ # 5.002 Configure and later have code to
+ #
+ # : Try to guess additional flags to pick up local libraries.
+ #
+ # which will automatically add --L/usr/local/lib because libpth
+ # contains /usr/local/lib
+ #
+ # Without it, if Configure finds libraries in /usr/local/lib (eg
+ # libgdbm.so) and adds them to the compiler commandline (as -lgdbm),
+ # then the link will fail. We can't fix this up in config.sh because
+ # the link will *also* fail in the test compiles that Configure does
+ # (eg $inlibc) which makes Configure get all sorts of things
+ # wrong. :-( So bodge it here.
+ #
+ # Possibly other platforms will need something similar. (if they
+ # have "wanted" libraries in /usr/local/lib, but the compiler
+ # doesn't default to putting that directory in its link path)
+ apply_patch(<<'EOPATCH');
+--- perl2/hints/freebsd.sh.orig 2011-10-05 16:44:55.000000000 +0200
++++ perl2/hints/freebsd.sh 2011-10-05 16:45:52.000000000 +0200
+@@ -125,7 +125,7 @@
+ else
+ libpth="/usr/lib /usr/local/lib"
+ glibpth="/usr/lib /usr/local/lib"
+- ldflags="-Wl,-E "
++ ldflags="-Wl,-E -L/usr/local/lib "
+ lddlflags="-shared "
+ fi
+ cccdlflags='-DPIC -fPIC'
+@@ -133,7 +133,7 @@
+ *)
+ libpth="/usr/lib /usr/local/lib"
+ glibpth="/usr/lib /usr/local/lib"
+- ldflags="-Wl,-E "
++ ldflags="-Wl,-E -L/usr/local/lib "
+ lddlflags="-shared "
+ cccdlflags='-DPIC -fPIC'
+ ;;
+
+EOPATCH
+ }
+}
+
# if Encode is not needed for the test, you can speed up the bisect by
# excluding it from the runs with -Dnoextensions=Encode
# ccache is an easy win. Remove it if it causes problems.
# Parallel build for miniperl is safe
system "make $j miniperl";
+my $expected = $target =~ /^test/ ? 't/perl'
+ : $target eq 'Fcntl' ? "lib/auto/Fcntl/Fcntl.$Config{so}"
+ : $target;
+my $real_target = $target eq 'Fcntl' ? $expected : $target;
+
if ($target ne 'miniperl') {
# Nearly all parallel build issues fixed by 5.10.0. Untrustworthy before that.
- $j = '' unless $major > 10;
+ $j = '' if $major < 10;
- if ($target eq 'test_prep') {
+ if ($real_target eq 'test_prep') {
if ($major < 8) {
# test-prep was added in 5.004_01, 3e3baf6d63945cb6.
# renamed to test_prep in 2001 in 5fe84fd29acaf55c.
# earlier than that, just make test. It will be fast enough.
- $target = extract_from_file('Makefile.SH', qr/^(test[-_]prep):/,
- 'test');
+ $real_target = extract_from_file('Makefile.SH',
+ qr/^(test[-_]prep):/,
+ 'test');
}
}
- system "make $j $target";
+ if ($major < 10
+ and -f 'ext/IPC/SysV/SysV.xs',
+ and my ($line) = extract_from_file('ext/IPC/SysV/SysV.xs',
+ qr!^(# *include <asm/page.h>)$!)) {
+ apply_patch(<<"EOPATCH");
+diff --git a/ext/IPC/SysV/SysV.xs b/ext/IPC/SysV/SysV.xs
+index 35a8fde..62a7965 100644
+--- a/ext/IPC/SysV/SysV.xs
++++ b/ext/IPC/SysV/SysV.xs
+\@\@ -4,7 +4,6 \@\@
+
+ #include <sys/types.h>
+ #ifdef __linux__
+-$line
+ #endif
+ #if defined(HAS_MSG) || defined(HAS_SEM) || defined(HAS_SHM)
+ #ifndef HAS_SEM
+EOPATCH
+ }
+ system "make $j $real_target";
}
-my $expected = $target eq 'test_prep' ? 'perl' : $target;
my $missing_target = $expected =~ /perl$/ ? !-x $expected : !-r $expected;
if ($options{'test-build'}) {
- report_and_exit($missing_target, 'could build', 'could not build', $target);
+ report_and_exit($missing_target, 'could build', 'could not build',
+ $real_target);
} elsif ($missing_target) {
- skip("could not build $target");
+ skip("could not build $real_target");
}
-match_and_exit($target) if $match;
+match_and_exit($real_target) if $match;
if (defined $options{'one-liner'}) {
- my $exe = $target eq 'perl' || $target eq 'test_prep' ? 'perl' : 'miniperl';
+ my $exe = $target =~ /^(?:perl$|test)/ ? 'perl' : 'miniperl';
unshift @ARGV, "./$exe", '-Ilib', '-e', $options{'one-liner'};
}
https://perl5.git.perl.org / perl5.git / blobdiff