X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/4ae6f81b38ab10f8a43c09b6efd34ae18e93ce42..6987f4434e4dfee71506125954ee1ae41c46f1cb:/make_ext.pl diff --git a/make_ext.pl b/make_ext.pl index 885322f..ce3debd 100644 --- a/make_ext.pl +++ b/make_ext.pl @@ -1,12 +1,12 @@ #!./miniperl use strict; use warnings; -use constant IS_CROSS => defined $::Cross::platform ? 1 : 0; use Config; - -my $is_Win32 = $^O eq 'MSWin32'; -my $is_VMS = $^O eq 'VMS'; -my $is_Unix = !$is_Win32 && !$is_VMS; +use constant{IS_CROSS => defined $Config::Config{usecrosscompile} ? 1 : 0, + IS_WIN32 => $^O eq 'MSWin32', + IS_VMS => $^O eq 'VMS', + IS_UNIX => $^O ne 'MSWin32' && $^O ne 'VMS', +}; my @ext_dirs = qw(cpan dist ext); my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')'; @@ -48,16 +48,32 @@ my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')'; # by an '!ext' and are appropriate to the type of building being done. # An extensions follows the format of Foo/Bar, which would be extension Foo::Bar +# To fix dependency ordering, on *nix systems, edit Makefile.SH to create a +# rule. That isn't sufficient for other systems; you also have to do +# something in this file. See the code at +# '# XXX hack for dependency # ordering' +# below. +# +# The basic logic is: +# 1) if there's a Makefile.PL in git for the module, use it. and call make +# 2) If not, auto-generate one (normally) +# 3) unless the auto-generation code figures out that the extension is +# *really* simple, in which case don't. This will be for pure perl +# modules, and all that is needed to be done is to copy from the source +# to the dest directories. +# # It may be deleted in a later release of perl so try to # avoid using it for other purposes. -my (%excl, %incl, %opts, @extspec, @pass_through); +my (%excl, %incl, %opts, @extspec, @pass_through, $verbose); foreach (@ARGV) { if (/^!(.*)$/) { $excl{$1} = 1; } elsif (/^\+(.*)$/) { $incl{$1} = 1; + } elsif (/^--verbose$/ or /^-v$/) { + $verbose = 1; } elsif (/^--([\w\-]+)$/) { $opts{$1} = 1; } elsif (/^--([\w\-]+)=(.*)$/) { @@ -120,15 +136,13 @@ unless(defined $makecmd and $makecmd =~ /^MAKE=(.*)$/) { # names, but neither did what it replaced. Once there is a use case that needs # it, please supply patches. Until then, I'm sticking to KISS my @make = split ' ', $1 || $Config{make} || $ENV{MAKE}; -# Using an array of 0 or 1 elements makes the subsequent code simpler. -my @run = $Config{run}; -@run = () if not defined $run[0] or $run[0] eq ''; if ($target eq '') { die "make_ext: no make target specified (eg all or clean)\n"; -} elsif ($target !~ /(?:^all|clean)$/) { - # for the time being we are strict about what make_ext is used for +} elsif ($target !~ /^(?:all|clean|distclean|realclean|veryclean)$/) { + # we are strict about what make_ext is used for because we emulate these + # targets for simple modules: die "$0: unknown make target '$target'\n"; } @@ -139,7 +153,7 @@ if (!@extspec and !$static and !$dynamic and !$nonxs and !$dynaloader) { my $perl; my %extra_passthrough; -if ($is_Win32) { +if (IS_WIN32) { require Cwd; require FindExt; my $build = Cwd::getcwd(); @@ -154,12 +168,12 @@ if ($is_Win32) { $ENV{PATH} = "$topdir;$topdir\\win32\\bin;$ENV{PATH}"; my $pl2bat = "$topdir\\win32\\bin\\pl2bat"; unless (-f "$pl2bat.bat") { - my @args = ($perl, "-I$topdir\\lib", ("$pl2bat.pl") x 2); - print "@args\n"; + my @args = ($perl, "-I$topdir\\lib", "-I$topdir\\cpan\\ExtUtils-PL2Bat\\lib", ("$pl2bat.pl") x 2); + print "@args\n" if $verbose; system(@args) unless IS_CROSS; } - print "In $build"; + print "In $build" if $verbose; foreach my $dir (@dirs) { chdir($dir) or die "Cannot cd to $dir: $!\n"; (my $ext = Cwd::getcwd()) =~ s{/}{\\}g; @@ -185,10 +199,7 @@ if ($is_Win32) { next; } push @extspec, $_; - if($_ eq 'DynaLoader' and $target !~ /clean$/) { - # No, we don't know why nmake can't work out the dependency chain - push @{$extra_passthrough{$_}}, 'DynaLoader.c'; - } elsif(FindExt::is_static($_)) { + if($_ ne 'DynaLoader' && FindExt::is_static($_)) { push @{$extra_passthrough{$_}}, 'LINKTYPE=static'; } } @@ -196,7 +207,7 @@ if ($is_Win32) { chdir '..' or die "Couldn't chdir to build directory: $!"; # now in the Perl build } -elsif ($is_VMS) { +elsif (IS_VMS) { $perl = $^X; push @extspec, (split ' ', $Config{static_ext}) if $static; push @extspec, (split ' ', $Config{dynamic_ext}) if $dynamic; @@ -204,25 +215,30 @@ elsif ($is_VMS) { push @extspec, 'DynaLoader' if $dynaloader; } -{ +{ # XXX hack for dependency ordering # Cwd needs to be built before Encode recurses into subdirectories. - # Pod::Simple needs to be built before Pod::Functions + # Pod::Simple needs to be built before Pod::Functions, but after 'if' + # lib needs to be built before IO-Compress # This seems to be the simplest way to ensure this ordering: - my (@first, @other); + my (@first, @second, @other); foreach (@extspec) { - if ($_ eq 'Cwd' || $_ eq 'Pod/Simple') { + if ($_ eq 'Cwd' || $_ eq 'if' || $_ eq 'lib') { push @first, $_; + } + elsif ($_ eq 'Pod/Simple') { + push @second, $_; } else { push @other, $_; } } - @extspec = (@first, @other); + @extspec = (@first, @second, @other); } if ($Config{osname} eq 'catamount' and @extspec) { # Snowball's chance of building extensions. die "This is $Config{osname}, not building $extspec[0], sorry.\n"; } +$ENV{PERL_CORE} = 1; foreach my $spec (@extspec) { my $mname = $spec; @@ -254,14 +270,14 @@ foreach my $spec (@extspec) { } } - print "\tMaking $mname ($target)\n"; + print "\tMaking $mname ($target)\n" if $verbose; - build_extension($ext_pathname, $perl, $mname, + build_extension($ext_pathname, $perl, $mname, $target, [@pass_through, @{$extra_passthrough{$spec} || []}]); } sub build_extension { - my ($ext_dir, $perl, $mname, $pass_through) = @_; + my ($ext_dir, $perl, $mname, $target, $pass_through) = @_; unless (chdir "$ext_dir") { warn "Cannot cd to $ext_dir: $!"; @@ -274,10 +290,9 @@ sub build_extension { $perl ||= "$up/miniperl"; my $return_dir = $up; my $lib_dir = "$up/lib"; - $ENV{PERL_CORE} = 1; - my $makefile; - if ($is_VMS) { + my ($makefile, $makefile_no_minus_f); + if (IS_VMS) { $makefile = 'descrip.mms'; if ($target =~ /clean$/ && !-f $makefile @@ -289,7 +304,8 @@ sub build_extension { } if (-f $makefile) { - open my $mfh, $makefile or die "Cannot open $makefile: $!"; + $makefile_no_minus_f = 0; + open my $mfh, '<', $makefile or die "Cannot open $makefile: $!"; while (<$mfh>) { # Plagiarised from CPAN::Distribution last if /MakeMaker post_initialize section/; @@ -304,7 +320,7 @@ sub build_extension { last unless defined $oldv; require ExtUtils::MM_Unix; defined (my $newv = parse_version MM $vmod) or last; - if ($newv ne $oldv) { + if (version->parse($newv) ne $oldv) { close $mfh or die "close $makefile: $!"; _unlink($makefile); { @@ -313,68 +329,78 @@ sub build_extension { } } } - if(IS_CROSS){ - seek($mfh, 0, 0) or die "Cannot seek $makefile: $!"; - while (<$mfh>) { - #this is used to stop the while loop early for efficiency when - #the line is reached, and possibly match a cross build - my $header = quotemeta '# These definitions are from config.sh (via '; - if(/^$header.+? - (xlib[\/\\] - $::Cross::platform\Q\/Config.pm\E)?\)\./x) { - unless (defined $1){ - print "Deleting non-Cross makefile\n"; - close $mfh or die "close $makefile: $!"; - _unlink($makefile); - { - no warnings 'deprecated'; - goto NO_MAKEFILE; - } - } else { #have a cross makefile - goto CROSS_OK_MF; - } - } - } #catch breakage from future changes - die "non-standard makefile found in $mname"; - CROSS_OK_MF: - } + + if (IS_CROSS) { + # If we're cross-compiling, it's possible that the host's + # Makefiles are around. + seek($mfh, 0, 0) or die "Cannot seek $makefile: $!"; + + my $cross_makefile; + while (<$mfh>) { + # XXX This might not be throughout enough. + # For example, it's possible to cause a false-positive + # if cross compiling on and for the Raspberry Pi, + # which is insane but plausible. + # False positives are really not troublesome, though; + # all they mean is that the module gets rebuilt. + if (/^CC = \Q$Config{cc}\E/) { + $cross_makefile = 1; + last; + } + } + + if (!$cross_makefile) { + print "Deleting non-Cross makefile\n"; + close $mfh or die "close $makefile: $!"; + _unlink($makefile); + } + } + } else { + $makefile_no_minus_f = 1; } - if (!-f $makefile) { + if ($makefile_no_minus_f || !-f $makefile) { NO_MAKEFILE: if (!-f 'Makefile.PL') { - print "\nCreating Makefile.PL in $ext_dir for $mname\n"; + unless (just_pm_to_blib($target, $ext_dir, $mname, $return_dir)) { + # No problems returned, so it has faked everything for us. :-) + chdir $return_dir || die "Cannot cd to $return_dir: $!"; + return; + } + + print "\nCreating Makefile.PL in $ext_dir for $mname\n" if $verbose; my ($fromname, $key, $value); - if ($mname eq 'podlators') { - # We need to special case this somewhere, and this is fewer - # lines of code than a core-only Makefile.PL, and no more - # complex - $fromname = 'VERSION'; - $key = 'DISTNAME'; - $value = 'podlators'; - $mname = 'Pod'; - } else { - $key = 'ABSTRACT_FROM'; - # We need to cope well with various possible layouts - my @dirs = split /::/, $mname; - my $leaf = pop @dirs; - my $leafname = "$leaf.pm"; - my $pathname = join '/', @dirs, $leafname; - my @locations = ($leafname, $pathname, "lib/$pathname"); - unshift @locations, 'lib/IO/Compress/Base.pm' if $mname eq 'IO::Compress'; - foreach (@locations) { - if (-f $_) { - $fromname = $_; - last; - } - } - unless ($fromname) { - die "For $mname tried @locations in in $ext_dir but can't find source"; + $key = 'ABSTRACT_FROM'; + # We need to cope well with various possible layouts + my @dirs = split /::/, $mname; + my $leaf = pop @dirs; + my $leafname = "$leaf.pm"; + my $pathname = join '/', @dirs, $leafname; + my @locations = ($leafname, $pathname, "lib/$pathname"); + foreach (@locations) { + if (-f $_) { + $fromname = $_; + last; } - ($value = $fromname) =~ s/\.pm\z/.pod/; - $value = $fromname unless -e $value; - } + } + + unless ($fromname) { + die "For $mname tried @locations in $ext_dir but can't find source"; + } + ($value = $fromname) =~ s/\.pm\z/.pod/; + $value = $fromname unless -e $value; + + if ($mname eq 'Pod::Checker') { + # the abstract in the .pm file is unparseable by MM, + # so special-case it. We can't use the package's own + # Makefile.PL, as it doesn't handle the executable scripts + # right. + $key = 'ABSTRACT'; + # this is copied from the CPAN Makefile.PL v 1.171 + $value = 'Pod::Checker verifies POD documentation contents for compliance with the POD format specifications'; + } + open my $fh, '>', 'Makefile.PL' or die "Can't open Makefile.PL for writing: $!"; printf $fh <<'EOM', $0, $mname, $fromname, $key, $value; @@ -438,24 +464,58 @@ EOM # the Makefile.PL. Altering the atime and mtime backwards by 4 # seconds seems to resolve the issue. eval { - my $ftime = time - 4; - utime $ftime, $ftime, 'Makefile.PL'; + my $ftime = (stat('Makefile.PL'))[9] - 4; + utime $ftime, $ftime, 'Makefile.PL'; }; - } - print "\nRunning Makefile.PL in $ext_dir\n"; - - # Presumably this can be simplified - my @cross; - if (IS_CROSS) { - # Inherited from win32/buildext.pl - @cross = "-MCross=$::Cross::platform"; - } elsif ($opts{cross}) { - # Inherited from make_ext.pl - @cross = '-MCross'; + } elsif ($mname =~ /\A(?:Carp + |ExtUtils::CBuilder + |Safe + |Search::Dict)\z/x) { + # An explicit list of dual-life extensions that have a Makefile.PL + # for CPAN, but we have verified can also be built using the fakery. + my ($problem) = just_pm_to_blib($target, $ext_dir, $mname, $return_dir); + # We really need to sanity test that we can fake it. + # Otherwise "skips" will go undetected, and the build slow down for + # everyone, defeating the purpose. + if (defined $problem) { + if (-d "$return_dir/.git") { + # Get the list of files that git isn't ignoring: + my @files = `git ls-files --cached --others --exclude-standard 2>/dev/null`; + # on error (eg no git) we get nothing, but that's not a + # problem. The goal is to see if git thinks that the problem + # file is interesting, by getting a positive match with + # something git told us about, and if so bail out: + foreach (@files) { + chomp; + # We really need to sanity test that we can fake it. + # The intent is that this should only fail because + # you've just added a file to the dual-life dist that + # we can't handle. In which case you should either + # 1) remove the dist from the regex a few lines above. + # or + # 2) add the file to regex of "safe" filenames earlier + # in this function, that starts with ChangeLog + die "FATAL - $0 has $mname in the list of simple extensions, but it now contains file '$problem' which we can't handle" + if $problem eq $_; + } + # There's an unexpected file, but it seems to be something + # that git will ignore. So fall through to the regular + # Makefile.PL handling code below, on the assumption that + # we won't get here for a clean build. + } + warn "WARNING - $0 is building $mname using EU::MM, as it found file '$problem'"; + } else { + # It faked everything for us. + chdir $return_dir || die "Cannot cd to $return_dir: $!"; + return; + } } - my @args = ("-I$lib_dir", @cross, 'Makefile.PL'); - if ($is_VMS) { + # We are going to have to use Makefile.PL: + print "\nRunning Makefile.PL in $ext_dir\n" if $verbose; + + my @args = ("-I$lib_dir", 'Makefile.PL'); + if (IS_VMS) { my $libd = VMS::Filespec::vmspath($lib_dir); push @args, "INST_LIB=$libd", "INST_ARCHLIB=$libd"; } else { @@ -463,10 +523,18 @@ EOM 'INSTALLMAN3DIR=none'; } push @args, @$pass_through; - _quote_args(\@args) if $is_VMS; - print join(' ', @run, $perl, @args), "\n"; - my $code = system @run, $perl, @args; - warn "$code from $ext_dir\'s Makefile.PL" if $code; + push @args, 'PERL=' . $perl if $perl; # use miniperl to run the Makefile later + _quote_args(\@args) if IS_VMS; + print join(' ', $perl, @args), "\n" if $verbose; + my $code = do { + local $ENV{PERL_MM_USE_DEFAULT} = 1; + system $perl, @args; + }; + if($code != 0){ + #make sure next build attempt/run of make_ext.pl doesn't succeed + _unlink($makefile); + die "Unsuccessful Makefile.PL($ext_dir): code=$code"; + } # Right. The reason for this little hack is that we're sitting inside # a program run by ./miniperl, but there are tasks we need to perform @@ -479,15 +547,9 @@ EOM # some of them rely on a $(PERL) for their own distclean targets. # But this always used to be a problem with the old /bin/sh version of # this. - if ($is_Unix) { - my $suffix = '.sh'; + if (IS_UNIX) { foreach my $clean_target ('realclean', 'veryclean') { - my $file = "$return_dir/$clean_target$suffix"; - open my $fh, '>>', $file or die "open $file: $!"; - # Quite possible that we're being run in parallel here. - # Can't use Fcntl this early to get the LOCK_EX - flock $fh, 2 or warn "flock $file: $!"; - print $fh <<"EOS"; + fallback_cleanup($return_dir, $clean_target, <<"EOS"); cd $ext_dir if test ! -f Makefile -a -f Makefile.old; then echo "Note: Using Makefile.old" @@ -496,11 +558,10 @@ else if test ! -f Makefile ; then echo "Warning: No Makefile!" fi - make $clean_target MAKE='@make' @pass_through + @make $clean_target MAKE='@make' @pass_through fi cd $return_dir EOS - close $fh or die "close $file: $!"; } } } @@ -509,7 +570,7 @@ EOS print "Warning: No Makefile!\n"; } - if ($is_VMS) { + if (IS_VMS) { _quote_args($pass_through); @$pass_through = ( "/DESCRIPTION=$makefile", @@ -517,15 +578,13 @@ EOS ); } - if (!$target or $target !~ /clean$/) { - # Give makefile an opportunity to rewrite itself. - # reassure users that life goes on... - my @args = ('config', @$pass_through); - system(@run, @make, @args) and print "@run @make @args failed, continuing anyway...\n"; - } my @targ = ($target, @$pass_through); - print "Making $target in $ext_dir\n@run @make @targ\n"; - my $code = system(@run, @make, @targ); + print "Making $target in $ext_dir\n@make @targ\n" if $verbose; + local $ENV{PERL_INSTALL_QUIET} = 1; + my $code = system(@make, @targ); + if($code >> 8 != 0){ # probably cleaned itself, try again once more time + $code = system(@make, @targ); + } die "Unsuccessful make($ext_dir): code=$code" if $code != 0; chdir $return_dir || die "Cannot cd to $return_dir: $!"; @@ -550,3 +609,173 @@ sub _unlink { my $err = $!; die "Can't unlink $_[0]: $err" if -f $_[0]; } + +# Figure out if this extension is simple enough that it would only use +# ExtUtils::MakeMaker's pm_to_blib target. If we're confident that it would, +# then do all the work ourselves (returning an empty list), else return the +# name of a file that we identified as beyond our ability to handle. +# +# While this is clearly quite a bit more work than just letting +# ExtUtils::MakeMaker do it, and effectively is some code duplication, the time +# savings are impressive. + +sub just_pm_to_blib { + my ($target, $ext_dir, $mname, $return_dir) = @_; + my ($has_lib, $has_top, $has_topdir); + my ($last) = $mname =~ /([^:]+)$/; + my ($first) = $mname =~ /^([^:]+)/; + + my $pm_to_blib = IS_VMS ? 'pm_to_blib.ts' : 'pm_to_blib'; + my $silent = defined $ENV{MAKEFLAGS} && $ENV{MAKEFLAGS} =~ /\b(s|silent|quiet)\b/; + + foreach my $leaf (<*>) { + if (-d $leaf) { + $leaf =~ s/\.DIR\z//i + if IS_VMS; + next if $leaf =~ /\A(?:\.|\.\.|t|demo)\z/; + if ($leaf eq 'lib') { + ++$has_lib; + next; + } + if ($leaf eq $first) { + ++$has_topdir; + next; + } + } + return $leaf + unless -f _; + $leaf =~ s/\.\z// + if IS_VMS; + # Makefile.PL is "safe" to ignore because we will only be called for + # directories that hold a Makefile.PL if they are in the exception list. + next + if $leaf =~ /\A(ChangeLog + |Changes + |LICENSE + |Makefile\.PL + |MANIFEST + |META\.yml + |\Q$pm_to_blib\E + |README + |README\.patching + |README\.release + )\z/xi; # /i to deal with case munging systems. + if ($leaf eq "$last.pm") { + ++$has_top; + next; + } + return $leaf; + } + return 'no lib/' + unless $has_lib || $has_top; + die "Inconsistent module $mname has both lib/ and $first/" + if $has_lib && $has_topdir; + + print "Running pm_to_blib for $ext_dir directly\n" + unless $silent; + + my %pm; + if ($has_top) { + my $to = $mname =~ s!::!/!gr; + $pm{"$last.pm"} = "../../lib/$to.pm"; + } + if ($has_lib || $has_topdir) { + # strictly ExtUtils::MakeMaker uses the pm_to_blib target to install + # .pm, pod and .pl files. We're just going to do it for .pm and .pod + # files, to avoid problems on case munging file systems. Specifically, + # _pm.PL which ExtUtils::MakeMaker should run munges to _PM.PL, and + # looks a lot like a regular foo.pl (ie FOO.PL) + my @found; + require File::Find; + unless (eval { + File::Find::find({ + no_chdir => 1, + wanted => sub { + return if -d $_; + # Bail out immediately with the problem file: + die \$_ + unless -f _; + die \$_ + unless /\A[^.]+\.(?:pm|pod)\z/i; + push @found, $_; + } + }, $has_lib ? 'lib' : $first); + 1; + }) { + # Problem files aren't really errors: + return ${$@} + if ref $@ eq 'SCALAR'; + # But anything else is: + die $@; + } + if ($has_lib) { + $pm{$_} = "../../$_" + foreach @found; + } else { + $pm{$_} = "../../lib/$_" + foreach @found; + } + } + # This is running under miniperl, so no autodie + if ($target eq 'all') { + my $need_update = 1; + if (-f $pm_to_blib) { + # avoid touching pm_to_blib unless there's something that + # needs updating, see #126710 + $need_update = 0; + my $test_at = -M _; + while (my $from = each(%pm)) { + if (-M $from < $test_at) { + ++$need_update; + last; + } + } + keys %pm; # reset iterator + } + + if ($need_update) { + local $ENV{PERL_INSTALL_QUIET} = 1; + require ExtUtils::Install; + ExtUtils::Install::pm_to_blib(\%pm, '../../lib/auto'); + open my $fh, '>', $pm_to_blib + or die "Can't open '$pm_to_blib': $!"; + print $fh "$0 has handled pm_to_blib directly\n"; + close $fh + or die "Can't close '$pm_to_blib': $!"; + if (IS_UNIX) { + # Fake the fallback cleanup + my $fallback + = join '', map {s!^\.\./\.\./!!; "rm -f $_\n"} sort values %pm; + foreach my $clean_target ('realclean', 'veryclean') { + fallback_cleanup($return_dir, $clean_target, $fallback); + } + } + } + } else { + # A clean target. + # For now, make the targets behave the same way as ExtUtils::MakeMaker + # does + _unlink($pm_to_blib); + unless ($target eq 'clean') { + # but cheat a bit, by relying on the top level Makefile clean target + # to take out our directory lib/auto/... + # (which it has to deal with, as cpan/foo/bar creates + # lib/auto/foo/bar, but the EU::MM rule will only + # rmdir lib/auto/foo/bar, leaving lib/auto/foo + _unlink($_) + foreach sort values %pm; + } + } + return; +} + +sub fallback_cleanup { + my ($dir, $clean_target, $contents) = @_; + my $file = "$dir/$clean_target.sh"; + open my $fh, '>>', $file or die "open $file: $!"; + # Quite possible that we're being run in parallel here. + # Can't use Fcntl this early to get the LOCK_EX + flock $fh, 2 or warn "flock $file: $!"; + print $fh $contents or die "print $file: $!"; + close $fh or die "close $file: $!"; +}