5 use constant{IS_CROSS => defined $Config::Config{usecrosscompile} ? 1 : 0,
6 IS_WIN32 => $^O eq 'MSWin32',
7 IS_VMS => $^O eq 'VMS',
8 IS_UNIX => $^O ne 'MSWin32' && $^O ne 'VMS',
11 my @ext_dirs = qw(cpan dist ext);
12 my $ext_dirs_re = '(?:' . join('|', @ext_dirs) . ')';
14 # This script acts as a simple interface for building extensions.
16 # It's actually a cut and shut of the Unix version ext/utils/makeext and the
17 # Windows version win32/build_ext.pl hence the two invocation styles.
19 # On Unix, it primarily used by the perl Makefile one extension at a time:
21 # d_dummy $(dynamic_ext): miniperl preplibrary FORCE
22 # @$(RUN) ./miniperl make_ext.pl --target=dynamic $@ MAKE=$(MAKE) LIBPERL_A=$(LIBPERL)
25 # If '--static' is specified, static extensions will be built.
26 # If '--dynamic' is specified, dynamic extensions will be built.
27 # If '--nonxs' is specified, nonxs extensions will be built.
28 # If '--dynaloader' is specified, DynaLoader will be built.
29 # If '--all' is specified, all extensions will be built.
31 # make_ext.pl "MAKE=make [-make_opts]" --dir=directory [--target=target] [--static|--dynamic|--all] +ext2 !ext1
35 # make_ext.pl "MAKE=nmake -nologo" --dir=..\ext
37 # make_ext.pl "MAKE=nmake -nologo" --dir=..\ext --target=clean
39 # Will skip building extensions which are marked with an '!' char.
40 # Mostly because they still not ported to specified platform.
42 # If any extensions are listed with a '+' char then only those
43 # extensions will be built, but only if they aren't countermanded
44 # by an '!ext' and are appropriate to the type of building being done.
45 # An extensions follows the format of Foo/Bar, which would be extension Foo::Bar
47 # To fix dependency ordering, on *nix systems, edit Makefile.SH to create a
48 # rule. That isn't sufficient for other systems; you also have to do
49 # something in this file. See the code at
50 # '# XXX hack for dependency # ordering'
54 # 1) if there's a Makefile.PL in git for the module, use it. and call make
55 # 2) If not, auto-generate one (normally)
56 # 3) unless the auto-generation code figures out that the extension is
57 # *really* simple, in which case don't. This will be for pure perl
58 # modules, and all that is needed to be done is to copy from the source
59 # to the dest directories.
61 # It may be deleted in a later release of perl so try to
62 # avoid using it for other purposes.
64 my (%excl, %incl, %opts, @extspec, @pass_through, $verbose);
69 } elsif (/^\+(.*)$/) {
71 } elsif (/^--verbose$/ or /^-v$/) {
73 } elsif (/^--([\w\-]+)$/) {
75 } elsif (/^--([\w\-]+)=(.*)$/) {
76 push @{$opts{$1}}, $2;
78 push @pass_through, $_;
84 my $static = $opts{static} || $opts{all};
85 my $dynamic = $opts{dynamic} || $opts{all};
86 my $nonxs = $opts{nonxs} || $opts{all};
87 my $dynaloader = $opts{dynaloader} || $opts{all};
89 # The Perl Makefile.SH will expand all extensions to
90 # lib/auto/X/X.a (or lib/auto/X/Y/Y.a if nested)
91 # A user wishing to run make_ext might use
92 # X (or X/Y or X::Y if nested)
94 # canonise into X/Y form (pname)
97 if (s{^lib/auto/}{}) {
98 # Remove lib/auto prefix and /*.* suffix
100 } elsif (s{^$ext_dirs_re/}{}) {
101 # Remove ext/ prefix and /pm_to_blib suffix
103 # Targets are given as files on disk, but the extension spec is still
104 # written using /s for each ::
106 } elsif (s{::}{\/}g) {
113 my $makecmd = shift @pass_through; # Should be something like MAKE=make
114 unshift @pass_through, 'PERL_CORE=1';
116 my @dirs = @{$opts{dir} || \@ext_dirs};
117 my $target = $opts{target}[0];
118 $target = 'all' unless defined $target;
120 # Previously, $make was taken from config.sh. However, the user might
121 # instead be running a possibly incompatible make. This might happen if
122 # the user types "gmake" instead of a plain "make", for example. The
123 # correct current value of MAKE will come through from the main perl
124 # makefile as MAKE=/whatever/make in $makecmd. We'll be cautious in
125 # case third party users of this script (are there any?) don't have the
126 # MAKE=$(MAKE) argument, which was added after 5.004_03.
127 unless(defined $makecmd and $makecmd =~ /^MAKE=(.*)$/) {
128 die "$0: WARNING: Please include MAKE=\$(MAKE) in \@ARGV\n";
131 # This isn't going to cope with anything fancy, such as spaces inside command
132 # names, but neither did what it replaced. Once there is a use case that needs
133 # it, please supply patches. Until then, I'm sticking to KISS
134 my @make = split ' ', $1 || $Config{make} || $ENV{MAKE};
138 die "make_ext: no make target specified (eg all or clean)\n";
139 } elsif ($target !~ /^(?:all|clean|distclean|realclean|veryclean)$/) {
140 # we are strict about what make_ext is used for because we emulate these
141 # targets for simple modules:
142 die "$0: unknown make target '$target'\n";
145 if (!@extspec and !$static and !$dynamic and !$nonxs and !$dynaloader) {
146 die "$0: no extension specified\n";
150 my %extra_passthrough;
155 my $build = Cwd::getcwd();
157 if ($perl =~ m#^\.\.#) {
160 $perl = "$here\\$perl";
162 (my $topdir = $perl) =~ s/\\[^\\]+$//;
163 # miniperl needs to find perlglob and pl2bat
164 $ENV{PATH} = "$topdir;$topdir\\win32\\bin;$ENV{PATH}";
165 my $pl2bat = "$topdir\\win32\\bin\\pl2bat";
166 unless (-f "$pl2bat.bat") {
167 my @args = ($perl, "-I$topdir\\lib", "-I$topdir\\cpan\\ExtUtils-PL2Bat\\lib", ("$pl2bat.pl") x 2);
168 print "@args\n" if $verbose;
169 system(@args) unless IS_CROSS;
172 print "In $build" if $verbose;
173 foreach my $dir (@dirs) {
174 chdir($dir) or die "Cannot cd to $dir: $!\n";
175 (my $ext = Cwd::getcwd()) =~ s{/}{\\}g;
176 FindExt::scan_ext($ext);
177 FindExt::set_static_extensions(split ' ', $Config{static_ext});
179 or die "Couldn't chdir to '$build': $!"; # restore our start directory
183 push @ext, FindExt::static_ext() if $static;
184 push @ext, FindExt::dynamic_ext() if $dynamic;
185 push @ext, FindExt::nonxs_ext() if $nonxs;
186 push @ext, 'DynaLoader' if $dynaloader;
188 foreach (sort @ext) {
189 if (%incl and !exists $incl{$_}) {
190 #warn "Skipping extension $_, not in inclusion list\n";
193 if (exists $excl{$_}) {
194 warn "Skipping extension $_, not ported to current platform";
198 if($_ ne 'DynaLoader' && FindExt::is_static($_)) {
199 push @{$extra_passthrough{$_}}, 'LINKTYPE=static';
204 or die "Couldn't chdir to build directory: $!"; # now in the Perl build
208 push @extspec, (split ' ', $Config{static_ext}) if $static;
209 push @extspec, (split ' ', $Config{dynamic_ext}) if $dynamic;
210 push @extspec, (split ' ', $Config{nonxs_ext}) if $nonxs;
211 push @extspec, 'DynaLoader' if $dynaloader;
214 { # XXX hack for dependency ordering
215 # Cwd needs to be built before Encode recurses into subdirectories.
216 # Pod::Simple needs to be built before Pod::Functions, but after 'if'
217 # lib needs to be built before IO-Compress
218 # This seems to be the simplest way to ensure this ordering:
219 my (@first, @second, @other);
221 if ($_ eq 'Cwd' || $_ eq 'if' || $_ eq 'lib') {
224 elsif ($_ eq 'Pod/Simple') {
230 @extspec = (@first, @second, @other);
233 if ($Config{osname} eq 'catamount' and @extspec) {
234 # Snowball's chance of building extensions.
235 die "This is $Config{osname}, not building $extspec[0], sorry.\n";
239 foreach my $spec (@extspec) {
244 # Try new style ext/Data-Dumper/ first
248 # List/Util.xs lives in Scalar-List-Utils, Cwd.xs lives in PathTools
249 $copy = 'Scalar-List-Utils' if $copy eq 'List-Util';
250 $copy = 'PathTools' if $copy eq 'Cwd';
252 foreach my $dir (@ext_dirs) {
253 if (-d "$dir/$copy") {
254 $ext_pathname = "$dir/$copy";
259 if (!defined $ext_pathname) {
260 if (-d "ext/$spec") {
261 # Old style ext/Data/Dumper/
262 $ext_pathname = "ext/$spec";
264 warn "Can't find extension $spec in any of @ext_dirs";
269 print "\tMaking $mname ($target)\n" if $verbose;
271 build_extension($ext_pathname, $perl, $mname, $target,
272 [@pass_through, @{$extra_passthrough{$spec} || []}]);
275 sub build_extension {
276 my ($ext_dir, $perl, $mname, $target, $pass_through) = @_;
278 unless (chdir "$ext_dir") {
279 warn "Cannot cd to $ext_dir: $!";
286 $perl ||= "$up/miniperl";
287 my $return_dir = $up;
288 my $lib_dir = "$up/lib";
290 my ($makefile, $makefile_no_minus_f);
292 $makefile = 'descrip.mms';
293 if ($target =~ /clean$/
295 && -f "${makefile}_old") {
296 $makefile = "${makefile}_old";
299 $makefile = 'Makefile';
303 $makefile_no_minus_f = 0;
304 open my $mfh, '<', $makefile or die "Cannot open $makefile: $!";
306 # Plagiarised from CPAN::Distribution
307 last if /MakeMaker post_initialize section/;
308 next unless /^#\s+VERSION_FROM\s+=>\s+(.+)/;
312 next unless /^XS_VERSION = (\S+)/;
316 last unless defined $oldv;
317 require ExtUtils::MM_Unix;
318 defined (my $newv = parse_version MM $vmod) or last;
319 if (version->parse($newv) ne $oldv) {
320 close $mfh or die "close $makefile: $!";
323 no warnings 'deprecated';
330 # If we're cross-compiling, it's possible that the host's
331 # Makefiles are around.
332 seek($mfh, 0, 0) or die "Cannot seek $makefile: $!";
336 # XXX This might not be throughout enough.
337 # For example, it's possible to cause a false-positive
338 # if cross compiling on and for the Raspberry Pi,
339 # which is insane but plausible.
340 # False positives are really not troublesome, though;
341 # all they mean is that the module gets rebuilt.
342 if (/^CC = \Q$Config{cc}\E/) {
348 if (!$cross_makefile) {
349 print "Deleting non-Cross makefile\n";
350 close $mfh or die "close $makefile: $!";
355 $makefile_no_minus_f = 1;
358 if ($makefile_no_minus_f || !-f $makefile) {
360 if (!-f 'Makefile.PL') {
361 unless (just_pm_to_blib($target, $ext_dir, $mname, $return_dir)) {
362 # No problems returned, so it has faked everything for us. :-)
363 chdir $return_dir || die "Cannot cd to $return_dir: $!";
367 print "\nCreating Makefile.PL in $ext_dir for $mname\n" if $verbose;
368 my ($fromname, $key, $value);
370 $key = 'ABSTRACT_FROM';
371 # We need to cope well with various possible layouts
372 my @dirs = split /::/, $mname;
373 my $leaf = pop @dirs;
374 my $leafname = "$leaf.pm";
375 my $pathname = join '/', @dirs, $leafname;
376 my @locations = ($leafname, $pathname, "lib/$pathname");
377 foreach (@locations) {
385 die "For $mname tried @locations in $ext_dir but can't find source";
387 ($value = $fromname) =~ s/\.pm\z/.pod/;
388 $value = $fromname unless -e $value;
390 if ($mname eq 'Pod::Checker') {
391 # the abstract in the .pm file is unparseable by MM,
392 # so special-case it. We can't use the package's own
393 # Makefile.PL, as it doesn't handle the executable scripts
396 # this is copied from the CPAN Makefile.PL v 1.171
397 $value = 'Pod::Checker verifies POD documentation contents for compliance with the POD format specifications';
400 open my $fh, '>', 'Makefile.PL'
401 or die "Can't open Makefile.PL for writing: $!";
402 printf $fh <<'EOM', $0, $mname, $fromname, $key, $value;
403 #-*- buffer-read-only: t -*-
405 # This Makefile.PL was written by %s.
406 # It will be deleted automatically by make realclean
409 use ExtUtils::MakeMaker;
411 # This is what the .PL extracts to. Not the ultimate file that is installed.
412 # (ie Win32 runs pl2bat after this)
414 # Doing this here avoids all sort of quoting issues that would come from
415 # attempting to write out perl source with literals to generate the arrays and
417 my @temps = 'Makefile.PL';
418 foreach (glob('scripts/pod*.PL')) {
419 # The various pod*.PL extractors change directory. Doing that with relative
420 # paths in @INC breaks. It seems the lesser of two evils to copy (to avoid)
421 # the chdir doing anything, than to attempt to convert lib paths to
422 # absolute, and potentially run into problems with quoting special
423 # characters in the path to our build dir (such as spaces)
427 $temp =~ s!scripts/!!;
428 File::Copy::copy($_, $temp) or die "Can't copy $temp to $_: $!";
432 my $script_ext = $^O eq 'VMS' ? '.com' : '';
434 foreach (glob('pod*.PL')) {
436 s/.PL$/$script_ext/i;
437 $pod_scripts{$script} = $_;
439 my @exe_files = values %%pod_scripts;
443 VERSION_FROM => '%s',
445 realclean => { FILES => "@temps" },
447 PL_FILES => \%%pod_scripts,
448 EXE_FILES => \@exe_files,
449 clean => { FILES => "@exe_files" },
455 close $fh or die "Can't close Makefile.PL: $!";
456 # As described in commit 23525070d6c0e51f:
457 # Push the atime and mtime of generated Makefile.PLs back 4
458 # seconds. In certain circumstances ( on virtual machines ) the
459 # generated Makefile.PL can produce a Makefile that is older than
460 # the Makefile.PL. Altering the atime and mtime backwards by 4
461 # seconds seems to resolve the issue.
463 my $ftime = (stat('Makefile.PL'))[9] - 4;
464 utime $ftime, $ftime, 'Makefile.PL';
466 } elsif ($mname =~ /\A(?:Carp
469 |Search::Dict)\z/x) {
470 # An explicit list of dual-life extensions that have a Makefile.PL
471 # for CPAN, but we have verified can also be built using the fakery.
472 my ($problem) = just_pm_to_blib($target, $ext_dir, $mname, $return_dir);
473 # We really need to sanity test that we can fake it.
474 # Otherwise "skips" will go undetected, and the build slow down for
475 # everyone, defeating the purpose.
476 if (defined $problem) {
477 if (-d "$return_dir/.git") {
478 # Get the list of files that git isn't ignoring:
479 my @files = `git ls-files --cached --others --exclude-standard 2>/dev/null`;
480 # on error (eg no git) we get nothing, but that's not a
481 # problem. The goal is to see if git thinks that the problem
482 # file is interesting, by getting a positive match with
483 # something git told us about, and if so bail out:
486 # We really need to sanity test that we can fake it.
487 # The intent is that this should only fail because
488 # you've just added a file to the dual-life dist that
489 # we can't handle. In which case you should either
490 # 1) remove the dist from the regex a few lines above.
492 # 2) add the file to regex of "safe" filenames earlier
493 # in this function, that starts with ChangeLog
494 die "FATAL - $0 has $mname in the list of simple extensions, but it now contains file '$problem' which we can't handle"
497 # There's an unexpected file, but it seems to be something
498 # that git will ignore. So fall through to the regular
499 # Makefile.PL handling code below, on the assumption that
500 # we won't get here for a clean build.
502 warn "WARNING - $0 is building $mname using EU::MM, as it found file '$problem'";
504 # It faked everything for us.
505 chdir $return_dir || die "Cannot cd to $return_dir: $!";
510 # We are going to have to use Makefile.PL:
511 print "\nRunning Makefile.PL in $ext_dir\n" if $verbose;
513 my @args = ("-I$lib_dir", 'Makefile.PL');
515 my $libd = VMS::Filespec::vmspath($lib_dir);
516 push @args, "INST_LIB=$libd", "INST_ARCHLIB=$libd";
518 push @args, 'INSTALLDIRS=perl', 'INSTALLMAN1DIR=none',
519 'INSTALLMAN3DIR=none';
521 push @args, @$pass_through;
522 push @args, 'PERL=' . $perl if $perl; # use miniperl to run the Makefile later
523 _quote_args(\@args) if IS_VMS;
524 print join(' ', $perl, @args), "\n" if $verbose;
526 local $ENV{PERL_MM_USE_DEFAULT} = 1;
530 #make sure next build attempt/run of make_ext.pl doesn't succeed
532 die "Unsuccessful Makefile.PL($ext_dir): code=$code";
535 # Right. The reason for this little hack is that we're sitting inside
536 # a program run by ./miniperl, but there are tasks we need to perform
537 # when the 'realclean', 'distclean' or 'veryclean' targets are run.
538 # Unfortunately, they can be run *after* 'clean', which deletes
540 # So we do our best to leave a set of instructions identical to what
541 # we would do if we are run directly as 'realclean' etc
542 # Whilst we're perfect, unfortunately the targets we call are not, as
543 # some of them rely on a $(PERL) for their own distclean targets.
544 # But this always used to be a problem with the old /bin/sh version of
547 foreach my $clean_target ('realclean', 'veryclean') {
548 fallback_cleanup($return_dir, $clean_target, <<"EOS");
550 if test ! -f Makefile -a -f Makefile.old; then
551 echo "Note: Using Makefile.old"
552 make -f Makefile.old $clean_target MAKE='@make' @pass_through
554 if test ! -f Makefile ; then
555 echo "Warning: No Makefile!"
557 @make $clean_target MAKE='@make' @pass_through
565 if (not -f $makefile) {
566 print "Warning: No Makefile!\n";
570 _quote_args($pass_through);
572 "/DESCRIPTION=$makefile",
573 '/MACRO=(' . join(',',@$pass_through) . ')'
577 my @targ = ($target, @$pass_through);
578 print "Making $target in $ext_dir\n@make @targ\n" if $verbose;
579 local $ENV{PERL_INSTALL_QUIET} = 1;
580 my $code = system(@make, @targ);
581 if($code >> 8 != 0){ # probably cleaned itself, try again once more time
582 $code = system(@make, @targ);
584 die "Unsuccessful make($ext_dir): code=$code" if $code != 0;
586 chdir $return_dir || die "Cannot cd to $return_dir: $!";
590 my $args = shift; # must be array reference
592 # Do not quote qualifiers that begin with '/'.
594 $_ =~ s/\"/""/g; # escape C<"> by doubling
601 #guarentee that a file is deleted or die, void _unlink($filename)
602 #xxx replace with _unlink_or_rename from EU::Install?
604 1 while unlink $_[0];
606 die "Can't unlink $_[0]: $err" if -f $_[0];
609 # Figure out if this extension is simple enough that it would only use
610 # ExtUtils::MakeMaker's pm_to_blib target. If we're confident that it would,
611 # then do all the work ourselves (returning an empty list), else return the
612 # name of a file that we identified as beyond our ability to handle.
614 # While this is clearly quite a bit more work than just letting
615 # ExtUtils::MakeMaker do it, and effectively is some code duplication, the time
616 # savings are impressive.
618 sub just_pm_to_blib {
619 my ($target, $ext_dir, $mname, $return_dir) = @_;
620 my ($has_lib, $has_top, $has_topdir);
621 my ($last) = $mname =~ /([^:]+)$/;
622 my ($first) = $mname =~ /^([^:]+)/;
624 my $pm_to_blib = IS_VMS ? 'pm_to_blib.ts' : 'pm_to_blib';
625 my $silent = defined $ENV{MAKEFLAGS} && $ENV{MAKEFLAGS} =~ /\b(s|silent|quiet)\b/;
627 foreach my $leaf (<*>) {
629 $leaf =~ s/\.DIR\z//i
631 next if $leaf =~ /\A(?:\.|\.\.|t|demo)\z/;
632 if ($leaf eq 'lib') {
636 if ($leaf eq $first) {
645 # Makefile.PL is "safe" to ignore because we will only be called for
646 # directories that hold a Makefile.PL if they are in the exception list.
648 if $leaf =~ /\A(ChangeLog
659 )\z/xi; # /i to deal with case munging systems.
660 if ($leaf eq "$last.pm") {
667 unless $has_lib || $has_top;
668 die "Inconsistent module $mname has both lib/ and $first/"
669 if $has_lib && $has_topdir;
671 print "Running pm_to_blib for $ext_dir directly\n"
676 my $to = $mname =~ s!::!/!gr;
677 $pm{"$last.pm"} = "../../lib/$to.pm";
679 if ($has_lib || $has_topdir) {
680 # strictly ExtUtils::MakeMaker uses the pm_to_blib target to install
681 # .pm, pod and .pl files. We're just going to do it for .pm and .pod
682 # files, to avoid problems on case munging file systems. Specifically,
683 # _pm.PL which ExtUtils::MakeMaker should run munges to _PM.PL, and
684 # looks a lot like a regular foo.pl (ie FOO.PL)
692 # Bail out immediately with the problem file:
696 unless /\A[^.]+\.(?:pm|pod)\z/i;
699 }, $has_lib ? 'lib' : $first);
702 # Problem files aren't really errors:
704 if ref $@ eq 'SCALAR';
705 # But anything else is:
712 $pm{$_} = "../../lib/$_"
716 # This is running under miniperl, so no autodie
717 if ($target eq 'all') {
719 if (-f $pm_to_blib) {
720 # avoid touching pm_to_blib unless there's something that
721 # needs updating, see #126710
724 while (my $from = each(%pm)) {
725 if (-M $from < $test_at) {
730 keys %pm; # reset iterator
734 local $ENV{PERL_INSTALL_QUIET} = 1;
735 require ExtUtils::Install;
736 ExtUtils::Install::pm_to_blib(\%pm, '../../lib/auto');
737 open my $fh, '>', $pm_to_blib
738 or die "Can't open '$pm_to_blib': $!";
739 print $fh "$0 has handled pm_to_blib directly\n";
741 or die "Can't close '$pm_to_blib': $!";
743 # Fake the fallback cleanup
745 = join '', map {s!^\.\./\.\./!!; "rm -f $_\n"} sort values %pm;
746 foreach my $clean_target ('realclean', 'veryclean') {
747 fallback_cleanup($return_dir, $clean_target, $fallback);
753 # For now, make the targets behave the same way as ExtUtils::MakeMaker
755 _unlink($pm_to_blib);
756 unless ($target eq 'clean') {
757 # but cheat a bit, by relying on the top level Makefile clean target
758 # to take out our directory lib/auto/...
759 # (which it has to deal with, as cpan/foo/bar creates
760 # lib/auto/foo/bar, but the EU::MM rule will only
761 # rmdir lib/auto/foo/bar, leaving lib/auto/foo
763 foreach sort values %pm;
769 sub fallback_cleanup {
770 my ($dir, $clean_target, $contents) = @_;
771 my $file = "$dir/$clean_target.sh";
772 open my $fh, '>>', $file or die "open $file: $!";
773 # Quite possible that we're being run in parallel here.
774 # Can't use Fcntl this early to get the LOCK_EX
775 flock $fh, 2 or warn "flock $file: $!";
776 print $fh $contents or die "print $file: $!";
777 close $fh or die "close $file: $!";