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 # make_ext.pl MAKE=dmake --dir=..\ext
41 # make_ext.pl MAKE=dmake --dir=..\ext --target=clean
43 # Will skip building extensions which are marked with an '!' char.
44 # Mostly because they still not ported to specified platform.
46 # If any extensions are listed with a '+' char then only those
47 # extensions will be built, but only if they aren't countermanded
48 # by an '!ext' and are appropriate to the type of building being done.
49 # An extensions follows the format of Foo/Bar, which would be extension Foo::Bar
51 # It may be deleted in a later release of perl so try to
52 # avoid using it for other purposes.
54 my (%excl, %incl, %opts, @extspec, @pass_through, $verbose);
59 } elsif (/^\+(.*)$/) {
61 } elsif (/^--verbose$/ or /^-v$/) {
63 } elsif (/^--([\w\-]+)$/) {
65 } elsif (/^--([\w\-]+)=(.*)$/) {
66 push @{$opts{$1}}, $2;
68 push @pass_through, $_;
74 my $static = $opts{static} || $opts{all};
75 my $dynamic = $opts{dynamic} || $opts{all};
76 my $nonxs = $opts{nonxs} || $opts{all};
77 my $dynaloader = $opts{dynaloader} || $opts{all};
79 # The Perl Makefile.SH will expand all extensions to
80 # lib/auto/X/X.a (or lib/auto/X/Y/Y.a if nested)
81 # A user wishing to run make_ext might use
82 # X (or X/Y or X::Y if nested)
84 # canonise into X/Y form (pname)
87 if (s{^lib/auto/}{}) {
88 # Remove lib/auto prefix and /*.* suffix
90 } elsif (s{^$ext_dirs_re/}{}) {
91 # Remove ext/ prefix and /pm_to_blib suffix
93 # Targets are given as files on disk, but the extension spec is still
94 # written using /s for each ::
96 } elsif (s{::}{\/}g) {
103 my $makecmd = shift @pass_through; # Should be something like MAKE=make
104 unshift @pass_through, 'PERL_CORE=1';
106 my @dirs = @{$opts{dir} || \@ext_dirs};
107 my $target = $opts{target}[0];
108 $target = 'all' unless defined $target;
110 # Previously, $make was taken from config.sh. However, the user might
111 # instead be running a possibly incompatible make. This might happen if
112 # the user types "gmake" instead of a plain "make", for example. The
113 # correct current value of MAKE will come through from the main perl
114 # makefile as MAKE=/whatever/make in $makecmd. We'll be cautious in
115 # case third party users of this script (are there any?) don't have the
116 # MAKE=$(MAKE) argument, which was added after 5.004_03.
117 unless(defined $makecmd and $makecmd =~ /^MAKE=(.*)$/) {
118 die "$0: WARNING: Please include MAKE=\$(MAKE) in \@ARGV\n";
121 # This isn't going to cope with anything fancy, such as spaces inside command
122 # names, but neither did what it replaced. Once there is a use case that needs
123 # it, please supply patches. Until then, I'm sticking to KISS
124 my @make = split ' ', $1 || $Config{make} || $ENV{MAKE};
128 die "make_ext: no make target specified (eg all or clean)\n";
129 } elsif ($target !~ /^(?:all|clean|distclean|realclean|veryclean)$/) {
130 # we are strict about what make_ext is used for because we emulate these
131 # targets for simple modules:
132 die "$0: unknown make target '$target'\n";
135 if (!@extspec and !$static and !$dynamic and !$nonxs and !$dynaloader) {
136 die "$0: no extension specified\n";
140 my %extra_passthrough;
145 my $build = Cwd::getcwd();
147 if ($perl =~ m#^\.\.#) {
150 $perl = "$here\\$perl";
152 (my $topdir = $perl) =~ s/\\[^\\]+$//;
153 # miniperl needs to find perlglob and pl2bat
154 $ENV{PATH} = "$topdir;$topdir\\win32\\bin;$ENV{PATH}";
155 my $pl2bat = "$topdir\\win32\\bin\\pl2bat";
156 unless (-f "$pl2bat.bat") {
157 my @args = ($perl, "-I$topdir\\lib", ("$pl2bat.pl") x 2);
158 print "@args\n" if $verbose;
159 system(@args) unless IS_CROSS;
162 print "In $build" if $verbose;
163 foreach my $dir (@dirs) {
164 chdir($dir) or die "Cannot cd to $dir: $!\n";
165 (my $ext = Cwd::getcwd()) =~ s{/}{\\}g;
166 FindExt::scan_ext($ext);
167 FindExt::set_static_extensions(split ' ', $Config{static_ext});
169 or die "Couldn't chdir to '$build': $!"; # restore our start directory
173 push @ext, FindExt::static_ext() if $static;
174 push @ext, FindExt::dynamic_ext() if $dynamic;
175 push @ext, FindExt::nonxs_ext() if $nonxs;
176 push @ext, 'DynaLoader' if $dynaloader;
178 foreach (sort @ext) {
179 if (%incl and !exists $incl{$_}) {
180 #warn "Skipping extension $_, not in inclusion list\n";
183 if (exists $excl{$_}) {
184 warn "Skipping extension $_, not ported to current platform";
188 if($_ ne 'DynaLoader' && FindExt::is_static($_)) {
189 push @{$extra_passthrough{$_}}, 'LINKTYPE=static';
194 or die "Couldn't chdir to build directory: $!"; # now in the Perl build
198 push @extspec, (split ' ', $Config{static_ext}) if $static;
199 push @extspec, (split ' ', $Config{dynamic_ext}) if $dynamic;
200 push @extspec, (split ' ', $Config{nonxs_ext}) if $nonxs;
201 push @extspec, 'DynaLoader' if $dynaloader;
205 # Cwd needs to be built before Encode recurses into subdirectories.
206 # Pod::Simple needs to be built before Pod::Functions
207 # This seems to be the simplest way to ensure this ordering:
210 if ($_ eq 'Cwd' || $_ eq 'Pod/Simple') {
216 @extspec = (@first, @other);
219 if ($Config{osname} eq 'catamount' and @extspec) {
220 # Snowball's chance of building extensions.
221 die "This is $Config{osname}, not building $extspec[0], sorry.\n";
225 foreach my $spec (@extspec) {
230 # Try new style ext/Data-Dumper/ first
234 # List/Util.xs lives in Scalar-List-Utils, Cwd.xs lives in PathTools
235 $copy = 'Scalar-List-Utils' if $copy eq 'List-Util';
236 $copy = 'PathTools' if $copy eq 'Cwd';
238 foreach my $dir (@ext_dirs) {
239 if (-d "$dir/$copy") {
240 $ext_pathname = "$dir/$copy";
245 if (!defined $ext_pathname) {
246 if (-d "ext/$spec") {
247 # Old style ext/Data/Dumper/
248 $ext_pathname = "ext/$spec";
250 warn "Can't find extension $spec in any of @ext_dirs";
255 print "\tMaking $mname ($target)\n" if $verbose;
257 build_extension($ext_pathname, $perl, $mname, $target,
258 [@pass_through, @{$extra_passthrough{$spec} || []}]);
261 sub build_extension {
262 my ($ext_dir, $perl, $mname, $target, $pass_through) = @_;
264 unless (chdir "$ext_dir") {
265 warn "Cannot cd to $ext_dir: $!";
272 $perl ||= "$up/miniperl";
273 my $return_dir = $up;
274 my $lib_dir = "$up/lib";
276 my ($makefile, $makefile_no_minus_f);
278 $makefile = 'descrip.mms';
279 if ($target =~ /clean$/
281 && -f "${makefile}_old") {
282 $makefile = "${makefile}_old";
285 $makefile = 'Makefile';
289 $makefile_no_minus_f = 0;
290 open my $mfh, '<', $makefile or die "Cannot open $makefile: $!";
292 # Plagiarised from CPAN::Distribution
293 last if /MakeMaker post_initialize section/;
294 next unless /^#\s+VERSION_FROM\s+=>\s+(.+)/;
298 next unless /^XS_VERSION = (\S+)/;
302 last unless defined $oldv;
303 require ExtUtils::MM_Unix;
304 defined (my $newv = parse_version MM $vmod) or last;
305 if ($newv ne $oldv) {
306 close $mfh or die "close $makefile: $!";
309 no warnings 'deprecated';
316 # If we're cross-compiling, it's possible that the host's
317 # Makefiles are around.
318 seek($mfh, 0, 0) or die "Cannot seek $makefile: $!";
322 # XXX This might not be throughout enough.
323 # For example, it's possible to cause a false-positive
324 # if cross compiling on and for the Raspberry Pi,
325 # which is insane but plausible.
326 # False positives are really not troublesome, though;
327 # all they mean is that the module gets rebuilt.
328 if (/^CC = \Q$Config{cc}\E/) {
334 if (!$cross_makefile) {
335 print "Deleting non-Cross makefile\n";
336 close $mfh or die "close $makefile: $!";
341 $makefile_no_minus_f = 1;
344 if ($makefile_no_minus_f || !-f $makefile) {
346 if (!-f 'Makefile.PL') {
347 unless (just_pm_to_blib($target, $ext_dir, $mname, $return_dir)) {
348 # No problems returned, so it has faked everything for us. :-)
349 chdir $return_dir || die "Cannot cd to $return_dir: $!";
353 print "\nCreating Makefile.PL in $ext_dir for $mname\n" if $verbose;
354 my ($fromname, $key, $value);
356 $key = 'ABSTRACT_FROM';
357 # We need to cope well with various possible layouts
358 my @dirs = split /::/, $mname;
359 my $leaf = pop @dirs;
360 my $leafname = "$leaf.pm";
361 my $pathname = join '/', @dirs, $leafname;
362 my @locations = ($leafname, $pathname, "lib/$pathname");
363 foreach (@locations) {
371 die "For $mname tried @locations in $ext_dir but can't find source";
373 ($value = $fromname) =~ s/\.pm\z/.pod/;
374 $value = $fromname unless -e $value;
376 if ($mname eq 'Pod::Checker') {
377 # the abstract in the .pm file is unparseable by MM,
378 # so special-case it. We can't use the package's own
379 # Makefile.PL, as it doesn't handle the executable scripts
382 # this is copied from the CPAN Makefile.PL v 1.171
383 $value = 'Pod::Checker verifies POD documentation contents for compliance with the POD format specifications';
386 open my $fh, '>', 'Makefile.PL'
387 or die "Can't open Makefile.PL for writing: $!";
388 printf $fh <<'EOM', $0, $mname, $fromname, $key, $value;
389 #-*- buffer-read-only: t -*-
391 # This Makefile.PL was written by %s.
392 # It will be deleted automatically by make realclean
395 use ExtUtils::MakeMaker;
397 # This is what the .PL extracts to. Not the ultimate file that is installed.
398 # (ie Win32 runs pl2bat after this)
400 # Doing this here avoids all sort of quoting issues that would come from
401 # attempting to write out perl source with literals to generate the arrays and
403 my @temps = 'Makefile.PL';
404 foreach (glob('scripts/pod*.PL')) {
405 # The various pod*.PL extractors change directory. Doing that with relative
406 # paths in @INC breaks. It seems the lesser of two evils to copy (to avoid)
407 # the chdir doing anything, than to attempt to convert lib paths to
408 # absolute, and potentially run into problems with quoting special
409 # characters in the path to our build dir (such as spaces)
413 $temp =~ s!scripts/!!;
414 File::Copy::copy($_, $temp) or die "Can't copy $temp to $_: $!";
418 my $script_ext = $^O eq 'VMS' ? '.com' : '';
420 foreach (glob('pod*.PL')) {
422 s/.PL$/$script_ext/i;
423 $pod_scripts{$script} = $_;
425 my @exe_files = values %%pod_scripts;
429 VERSION_FROM => '%s',
431 realclean => { FILES => "@temps" },
433 PL_FILES => \%%pod_scripts,
434 EXE_FILES => \@exe_files,
435 clean => { FILES => "@exe_files" },
441 close $fh or die "Can't close Makefile.PL: $!";
442 # As described in commit 23525070d6c0e51f:
443 # Push the atime and mtime of generated Makefile.PLs back 4
444 # seconds. In certain circumstances ( on virtual machines ) the
445 # generated Makefile.PL can produce a Makefile that is older than
446 # the Makefile.PL. Altering the atime and mtime backwards by 4
447 # seconds seems to resolve the issue.
449 my $ftime = (stat('Makefile.PL'))[9] - 4;
450 utime $ftime, $ftime, 'Makefile.PL';
452 } elsif ($mname =~ /\A(?:Carp
455 |Search::Dict)\z/x) {
456 # An explicit list of dual-life extensions that have a Makefile.PL
457 # for CPAN, but we have verified can also be built using the fakery.
458 my ($problem) = just_pm_to_blib($target, $ext_dir, $mname, $return_dir);
459 # We really need to sanity test that we can fake it.
460 # Otherwise "skips" will go undetected, and the build slow down for
461 # everyone, defeating the purpose.
462 if (defined $problem) {
463 if (-d "$return_dir/.git") {
464 # Get the list of files that git isn't ignoring:
465 my @files = `git ls-files --cached --others --exclude-standard 2>/dev/null`;
466 # on error (eg no git) we get nothing, but that's not a
467 # problem. The goal is to see if git thinks that the problem
468 # file is interesting, by getting a positive match with
469 # something git told us about, and if so bail out:
472 # We really need to sanity test that we can fake it.
473 # The intent is that this should only fail because
474 # you've just added a file to the dual-life dist that
475 # we can't handle. In which case you should either
476 # 1) remove the dist from the regex a few lines above.
478 # 2) add the file to regex of "safe" filenames earlier
479 # in this function, that starts with ChangeLog
480 die "FATAL - $0 has $mname in the list of simple extensions, but it now contains file '$problem' which we can't handle"
483 # There's an unexpected file, but it seems to be something
484 # that git will ignore. So fall through to the regular
485 # Makefile.PL handling code below, on the assumption that
486 # we won't get here for a clean build.
488 warn "WARNING - $0 is building $mname using EU::MM, as it found file '$problem'";
490 # It faked everything for us.
491 chdir $return_dir || die "Cannot cd to $return_dir: $!";
496 # We are going to have to use Makefile.PL:
497 print "\nRunning Makefile.PL in $ext_dir\n" if $verbose;
499 my @args = ("-I$lib_dir", 'Makefile.PL');
501 my $libd = VMS::Filespec::vmspath($lib_dir);
502 push @args, "INST_LIB=$libd", "INST_ARCHLIB=$libd";
504 push @args, 'INSTALLDIRS=perl', 'INSTALLMAN1DIR=none',
505 'INSTALLMAN3DIR=none';
507 push @args, @$pass_through;
508 _quote_args(\@args) if IS_VMS;
509 print join(' ', $perl, @args), "\n" if $verbose;
511 local $ENV{PERL_MM_USE_DEFAULT} = 1;
515 #make sure next build attempt/run of make_ext.pl doesn't succeed
517 die "Unsuccessful Makefile.PL($ext_dir): code=$code";
520 # Right. The reason for this little hack is that we're sitting inside
521 # a program run by ./miniperl, but there are tasks we need to perform
522 # when the 'realclean', 'distclean' or 'veryclean' targets are run.
523 # Unfortunately, they can be run *after* 'clean', which deletes
525 # So we do our best to leave a set of instructions identical to what
526 # we would do if we are run directly as 'realclean' etc
527 # Whilst we're perfect, unfortunately the targets we call are not, as
528 # some of them rely on a $(PERL) for their own distclean targets.
529 # But this always used to be a problem with the old /bin/sh version of
532 foreach my $clean_target ('realclean', 'veryclean') {
533 fallback_cleanup($return_dir, $clean_target, <<"EOS");
535 if test ! -f Makefile -a -f Makefile.old; then
536 echo "Note: Using Makefile.old"
537 make -f Makefile.old $clean_target MAKE='@make' @pass_through
539 if test ! -f Makefile ; then
540 echo "Warning: No Makefile!"
542 @make $clean_target MAKE='@make' @pass_through
550 if (not -f $makefile) {
551 print "Warning: No Makefile!\n";
555 _quote_args($pass_through);
557 "/DESCRIPTION=$makefile",
558 '/MACRO=(' . join(',',@$pass_through) . ')'
562 my @targ = ($target, @$pass_through);
563 print "Making $target in $ext_dir\n@make @targ\n" if $verbose;
564 local $ENV{PERL_INSTALL_QUIET} = 1;
565 my $code = system(@make, @targ);
566 if($code >> 8 != 0){ # probably cleaned itself, try again once more time
567 $code = system(@make, @targ);
569 die "Unsuccessful make($ext_dir): code=$code" if $code != 0;
571 chdir $return_dir || die "Cannot cd to $return_dir: $!";
575 my $args = shift; # must be array reference
577 # Do not quote qualifiers that begin with '/'.
579 $_ =~ s/\"/""/g; # escape C<"> by doubling
586 #guarentee that a file is deleted or die, void _unlink($filename)
587 #xxx replace with _unlink_or_rename from EU::Install?
589 1 while unlink $_[0];
591 die "Can't unlink $_[0]: $err" if -f $_[0];
594 # Figure out if this extension is simple enough that it would only use
595 # ExtUtils::MakeMaker's pm_to_blib target. If we're confident that it would,
596 # then do all the work ourselves (returning an empty list), else return the
597 # name of a file that we identified as beyond our ability to handle.
599 # While this is clearly quite a bit more work than just letting
600 # ExtUtils::MakeMaker do it, and effectively is some code duplication, the time
601 # savings are impressive.
603 sub just_pm_to_blib {
604 my ($target, $ext_dir, $mname, $return_dir) = @_;
605 my ($has_lib, $has_top, $has_topdir);
606 my ($last) = $mname =~ /([^:]+)$/;
607 my ($first) = $mname =~ /^([^:]+)/;
609 my $pm_to_blib = IS_VMS ? 'pm_to_blib.ts' : 'pm_to_blib';
610 my $silent = defined $ENV{MAKEFLAGS} && $ENV{MAKEFLAGS} =~ /\b(s|silent|quiet)\b/;
612 foreach my $leaf (<*>) {
614 $leaf =~ s/\.DIR\z//i
616 next if $leaf =~ /\A(?:\.|\.\.|t|demo)\z/;
617 if ($leaf eq 'lib') {
621 if ($leaf eq $first) {
630 # Makefile.PL is "safe" to ignore because we will only be called for
631 # directories that hold a Makefile.PL if they are in the exception list.
633 if $leaf =~ /\A(ChangeLog
643 )\z/xi; # /i to deal with case munging systems.
644 if ($leaf eq "$last.pm") {
651 unless $has_lib || $has_top;
652 die "Inconsistent module $mname has both lib/ and $first/"
653 if $has_lib && $has_topdir;
655 print "Running pm_to_blib for $ext_dir directly\n"
660 my $to = $mname =~ s!::!/!gr;
661 $pm{"$last.pm"} = "../../lib/$to.pm";
663 if ($has_lib || $has_topdir) {
664 # strictly ExtUtils::MakeMaker uses the pm_to_blib target to install
665 # .pm, pod and .pl files. We're just going to do it for .pm and .pod
666 # files, to avoid problems on case munging file systems. Specifically,
667 # _pm.PL which ExtUtils::MakeMaker should run munges to _PM.PL, and
668 # looks a lot like a regular foo.pl (ie FOO.PL)
676 # Bail out immediately with the problem file:
680 unless /\A[^.]+\.(?:pm|pod)\z/i;
683 }, $has_lib ? 'lib' : $first);
686 # Problem files aren't really errors:
688 if ref $@ eq 'SCALAR';
689 # But anything else is:
696 $pm{$_} = "../../lib/$_"
700 # This is running under miniperl, so no autodie
701 if ($target eq 'all') {
703 if (-f $pm_to_blib) {
704 # avoid touching pm_to_blib unless there's something that
705 # needs updating, see #126710
708 while (my $from = each(%pm)) {
709 if (-M $from < $test_at) {
714 keys %pm; # reset iterator
718 local $ENV{PERL_INSTALL_QUIET} = 1;
719 require ExtUtils::Install;
720 ExtUtils::Install::pm_to_blib(\%pm, '../../lib/auto');
721 open my $fh, '>', $pm_to_blib
722 or die "Can't open '$pm_to_blib': $!";
723 print $fh "$0 has handled pm_to_blib directly\n";
725 or die "Can't close '$pm_to_blib': $!";
727 # Fake the fallback cleanup
729 = join '', map {s!^\.\./\.\./!!; "rm -f $_\n"} sort values %pm;
730 foreach my $clean_target ('realclean', 'veryclean') {
731 fallback_cleanup($return_dir, $clean_target, $fallback);
737 # For now, make the targets behave the same way as ExtUtils::MakeMaker
739 _unlink($pm_to_blib);
740 unless ($target eq 'clean') {
741 # but cheat a bit, by relying on the top level Makefile clean target
742 # to take out our directory lib/auto/...
743 # (which it has to deal with, as cpan/foo/bar creates
744 # lib/auto/foo/bar, but the EU::MM rule will only
745 # rmdir lib/auto/foo/bar, leaving lib/auto/foo
747 foreach sort values %pm;
753 sub fallback_cleanup {
754 my ($dir, $clean_target, $contents) = @_;
755 my $file = "$dir/$clean_target.sh";
756 open my $fh, '>>', $file or die "open $file: $!";
757 # Quite possible that we're being run in parallel here.
758 # Can't use Fcntl this early to get the LOCK_EX
759 flock $fh, 2 or warn "flock $file: $!";
760 print $fh $contents or die "print $file: $!";
761 close $fh or die "close $file: $!";