1 package ExtUtils::Liblist;
3 # Broken out of MakeMaker from version 4.11
5 $VERSION = substr q$Revision: 1.25 $, 10;
12 if ($^O eq 'VMS') { return &_vms_ext; }
13 elsif($^O eq 'MSWin32') { return &_win32_ext; }
14 else { return &_unix_os2_ext; }
18 my($self,$potential_libs, $verbose) = @_;
19 if ($^O =~ 'os2' and $Config{libs}) {
20 # Dynamic libraries are not transitive, so we may need including
21 # the libraries linked against perl.dll again.
23 $potential_libs .= " " if $potential_libs;
24 $potential_libs .= $Config{libs};
26 return ("", "", "", "") unless $potential_libs;
27 warn "Potential libraries are '$potential_libs':\n" if $verbose;
29 my($so) = $Config{'so'};
30 my($libs) = $Config{'libs'};
31 my $Config_libext = $Config{lib_ext} || ".a";
34 # compute $extralibs, $bsloadlibs and $ldloadlibs from
36 # this is a rewrite of Andy Dougherty's extliblist in perl
38 my(@searchpath); # from "-L/path" entries in $potential_libs
39 my(@libpath) = split " ", $Config{'libpth'};
40 my(@ldloadlibs, @bsloadlibs, @extralibs, @ld_run_path, %ld_run_path_seen);
41 my($fullname, $thislib, $thispth, @fullname);
42 my($pwd) = cwd(); # from Cwd.pm
45 foreach $thislib (split ' ', $potential_libs){
47 # Handle possible linker path arguments.
48 if ($thislib =~ s/^(-[LR])//){ # save path flag type
51 warn "$ptype$thislib ignored, directory does not exist\n"
55 unless ($self->file_name_is_absolute($thislib)) {
56 warn "Warning: $ptype$thislib changed to $ptype$pwd/$thislib\n";
57 $thislib = $self->catdir($pwd,$thislib);
59 push(@searchpath, $thislib);
60 push(@extralibs, "$ptype$thislib");
61 push(@ldloadlibs, "$ptype$thislib");
65 # Handle possible library arguments.
66 unless ($thislib =~ s/^-l//){
67 warn "Unrecognized argument in LIBS ignored: '$thislib'\n";
72 foreach $thispth (@searchpath, @libpath){
74 # Try to find the full name of the library. We need this to
75 # determine whether it's a dynamically-loadable library or not.
76 # This tends to be subject to various os-specific quirks.
77 # For gcc-2.6.2 on linux (March 1995), DLD can not load
78 # .sa libraries, with the exception of libm.sa, so we
79 # deliberately skip them.
81 $self->lsdir($thispth,"^\Qlib$thislib.$so.\E[0-9]+")){
82 # Take care that libfoo.so.10 wins against libfoo.so.9.
83 # Compare two libraries to find the most recent version
84 # number. E.g. if you have libfoo.so.9.0.7 and
85 # libfoo.so.10.1, first convert all digits into two
86 # decimal places. Then we'll add ".00" to the shorter
87 # strings so that we're comparing strings of equal length
88 # Thus we'll compare libfoo.so.09.07.00 with
89 # libfoo.so.10.01.00. Some libraries might have letters
90 # in the version. We don't know what they mean, but will
91 # try to skip them gracefully -- we'll set any letter to
92 # '0'. Finally, sort in reverse so we can take the
95 #TODO: iterate through the directory instead of sorting
97 $fullname = "$thispth/" .
100 $ma =~ tr/A-Za-z/0/s;
101 $ma =~ s/\b(\d)\b/0$1/g;
102 $mb =~ tr/A-Za-z/0/s;
103 $mb =~ s/\b(\d)\b/0$1/g;
104 while (length($ma) < length($mb)) { $ma .= ".00"; }
105 while (length($mb) < length($ma)) { $mb .= ".00"; }
106 # Comparison deliberately backwards
107 $mb cmp $ma;} @fullname)[0];
108 } elsif (-f ($fullname="$thispth/lib$thislib.$so")
109 && (($Config{'dlsrc'} ne "dl_dld.xs") || ($thislib eq "m"))){
110 } elsif (-f ($fullname="$thispth/lib${thislib}_s$Config_libext")
111 && ($thislib .= "_s") ){ # we must explicitly use _s version
112 } elsif (-f ($fullname="$thispth/lib$thislib$Config_libext")){
113 } elsif (-f ($fullname="$thispth/$thislib$Config_libext")){
114 } elsif (-f ($fullname="$thispth/Slib$thislib$Config_libext")){
115 } elsif ($^O eq 'dgux'
116 && -l ($fullname="$thispth/lib$thislib$Config_libext")
117 && readlink($fullname) =~ /^elink:/) {
118 # Some of DG's libraries look like misconnected symbolic
119 # links, but development tools can follow them. (They
122 # libm.a -> elink:${SDE_PATH:-/usr}/sde/\
123 # ${TARGET_BINARY_INTERFACE:-m88kdgux}/usr/lib/libm.a
125 # , the compilation tools expand the environment variables.)
127 warn "$thislib not found in $thispth\n" if $verbose;
130 warn "'-l$thislib' found at $fullname\n" if $verbose;
131 my($fullnamedir) = dirname($fullname);
132 push @ld_run_path, $fullnamedir unless $ld_run_path_seen{$fullnamedir}++;
136 # Now update library lists
138 # what do we know about this library...
139 my $is_dyna = ($fullname !~ /\Q$Config_libext\E$/);
140 my $in_perl = ($libs =~ /\B-l\Q$ {thislib}\E\b/s);
142 # Do not add it into the list if it is already linked in
143 # with the main perl executable.
144 # We have to special-case the NeXT, because math and ndbm
145 # are both in libsys_s
147 ($Config{'osname'} eq 'next' &&
148 ($thislib eq 'm' || $thislib eq 'ndbm')) ){
149 push(@extralibs, "-l$thislib");
152 # We might be able to load this archive file dynamically
153 if ( ($Config{'dlsrc'} =~ /dl_next/ && $Config{'osvers'} lt '4_0')
154 || ($Config{'dlsrc'} =~ /dl_dld/) )
156 # We push -l$thislib instead of $fullname because
157 # it avoids hardwiring a fixed path into the .bs file.
158 # Mkbootstrap will automatically add dl_findfile() to
159 # the .bs file if it sees a name in the -l format.
160 # USE THIS, when dl_findfile() is fixed:
161 # push(@bsloadlibs, "-l$thislib");
162 # OLD USE WAS while checking results against old_extliblist
163 push(@bsloadlibs, "$fullname");
166 # For SunOS4, do not add in this shared library if
167 # it is already linked in the main perl executable
168 push(@ldloadlibs, "-l$thislib")
169 unless ($in_perl and $^O eq 'sunos');
171 push(@ldloadlibs, "-l$thislib");
174 last; # found one here so don't bother looking further
176 warn "Note (probably harmless): "
177 ."No library found for -l$thislib\n"
180 return ('','','','') unless $found;
181 ("@extralibs", "@bsloadlibs", "@ldloadlibs",join(":",@ld_run_path));
186 require Text::ParseWords;
188 my($self, $potential_libs, $verbose) = @_;
190 # If user did not supply a list, we punt.
191 # (caller should probably use the list in $Config{libs})
192 return ("", "", "", "") unless $potential_libs;
194 my($so) = $Config{'so'};
195 my($libs) = $Config{'libs'};
196 my($libpth) = $Config{'libpth'};
197 my($libext) = $Config{'lib_ext'} || ".lib";
199 if ($libs and $potential_libs !~ /:nodefault/i) {
200 # If Config.pm defines a set of default libs, we always
201 # tack them on to the user-supplied list, unless the user
202 # specified :nodefault
204 $potential_libs .= " " if $potential_libs;
205 $potential_libs .= $libs;
207 warn "Potential libraries are '$potential_libs':\n" if $verbose;
209 # normalize to forward slashes
211 $potential_libs =~ s,\\,/,g;
213 # compute $extralibs from $potential_libs
215 my(@searchpath); # from "-L/path" entries in $potential_libs
216 my(@libpath) = Text::ParseWords::quotewords('\s+', 0, $libpth);
218 my($fullname, $thislib, $thispth);
219 my($pwd) = cwd(); # from Cwd.pm
223 foreach $thislib (Text::ParseWords::quotewords('\s+', 0, $potential_libs)){
225 # Handle possible linker path arguments.
226 if ($thislib =~ s/^-L// and not -d $thislib) {
227 warn "-L$thislib ignored, directory does not exist\n"
231 elsif (-d $thislib) {
232 unless ($self->file_name_is_absolute($thislib)) {
233 warn "Warning: '-L$thislib' changed to '-L$pwd/$thislib'\n";
234 $thislib = $self->catdir($pwd,$thislib);
236 push(@searchpath, $thislib);
240 # Handle possible library arguments.
241 if ($thislib =~ s/^-l// and $thislib !~ /^lib/i) {
242 $thislib = "lib$thislib";
244 $thislib .= $libext if $thislib !~ /\Q$libext\E$/i;
247 foreach $thispth (@searchpath, @libpath){
248 unless (-f ($fullname="$thispth\\$thislib")) {
249 warn "$thislib not found in $thispth\n" if $verbose;
252 warn "'$thislib' found at $fullname\n" if $verbose;
255 push(@extralibs, $fullname);
258 warn "Note (probably harmless): "
259 ."No library found for '$thislib'\n"
262 return ('','','','') unless $found;
264 # make sure paths with spaces are properly quoted
265 @extralibs = map { (/\s/ && !/^".*"$/) ? qq["$_"] : $_ } @extralibs;
266 $lib = join(' ',@extralibs);
268 # normalize back to backward slashes (to help braindead tools)
269 # XXX this may break equally braindead GNU tools that don't understand
270 # backslashes, either. Seems like one can't win here. Cursed be CP/M.
273 warn "Result: $lib\n" if $verbose;
274 wantarray ? ($lib, '', $lib, '') : $lib;
279 my($self, $potential_libs,$verbose) = @_;
281 my($dbgqual) = $self->{OPTIMIZE} || $Config{'optimize'} ||
282 $self->{CCFLAS} || $Config{'ccflags'};
283 @crtls = ( ($dbgqual =~ m-/Debug-i ? $Config{'dbgprefix'} : '')
285 push(@crtls, grep { not /\(/ } split /\s+/, $Config{'libs'});
286 push(@crtls, grep { not /\(/ } split /\s+/, $Config{'libc'});
287 # In general, we pass through the basic libraries from %Config unchanged.
288 # The one exception is that if we're building in the Perl source tree, and
289 # a library spec could be resolved via a logical name, we go to some trouble
290 # to insure that the copy in the local tree is used, rather than one to
291 # which a system-wide logical may point.
292 if ($self->{PERL_SRC}) {
293 my($lib,$locspec,$type);
294 foreach $lib (@crtls) {
295 if (($locspec,$type) = $lib =~ m-^([\w$\-]+)(/\w+)?- and $locspec =~ /perl/i) {
296 if (lc $type eq '/share') { $locspec .= $Config{'exe_ext'}; }
297 elsif (lc $type eq '/library') { $locspec .= $Config{'lib_ext'}; }
298 else { $locspec .= $Config{'obj_ext'}; }
299 $locspec = $self->catfile($self->{PERL_SRC},$locspec);
300 $lib = "$locspec$type" if -e $locspec;
304 $crtlstr = @crtls ? join(' ',@crtls) : '';
306 unless ($potential_libs) {
307 warn "Result:\n\tEXTRALIBS: \n\tLDLOADLIBS: $crtlstr\n" if $verbose;
308 return ('', '', $crtlstr, '');
311 my(@dirs,@libs,$dir,$lib,%sh,%olb,%obj,$ldlib);
313 my($so,$lib_ext,$obj_ext) = @Config{'so','lib_ext','obj_ext'};
314 # List of common Unix library names and there VMS equivalents
315 # (VMS equivalent of '' indicates that the library is automatially
316 # searched by the linker, and should be skipped here.)
317 my %libmap = ( 'm' => '', 'f77' => '', 'F77' => '', 'V77' => '', 'c' => '',
318 'malloc' => '', 'crypt' => '', 'resolv' => '', 'c_s' => '',
319 'socket' => '', 'X11' => 'DECW$XLIBSHR',
320 'Xt' => 'DECW$XTSHR', 'Xm' => 'DECW$XMLIBSHR',
321 'Xmu' => 'DECW$XMULIBSHR');
322 if ($Config{'vms_cc_type'} ne 'decc') { $libmap{'curses'} = 'VAXCCURSE'; }
324 warn "Potential libraries are '$potential_libs'\n" if $verbose;
326 # First, sort out directories and library names in the input
327 foreach $lib (split ' ',$potential_libs) {
328 push(@dirs,$1), next if $lib =~ /^-L(.*)/;
329 push(@dirs,$lib), next if $lib =~ /[:>\]]$/;
330 push(@dirs,$lib), next if -d $lib;
331 push(@libs,$1), next if $lib =~ /^-l(.*)/;
334 push(@dirs,split(' ',$Config{'libpth'}));
336 # Now make sure we've got VMS-syntax absolute directory specs
337 # (We don't, however, check whether someone's hidden a relative
338 # path in a logical name.)
339 foreach $dir (@dirs) {
341 warn "Skipping nonexistent Directory $dir\n" if $verbose > 1;
345 warn "Resolving directory $dir\n" if $verbose;
346 if ($self->file_name_is_absolute($dir)) { $dir = $self->fixpath($dir,1); }
347 else { $dir = $self->catdir($cwd,$dir); }
349 @dirs = grep { length($_) } @dirs;
350 unshift(@dirs,''); # Check each $lib without additions first
352 LIB: foreach $lib (@libs) {
353 if (exists $libmap{$lib}) {
354 next unless length $libmap{$lib};
355 $lib = $libmap{$lib};
358 my(@variants,$variant,$name,$test,$cand);
361 # If we don't have a file type, consider it a possibly abbreviated name and
362 # check for common variants. We try these first to grab libraries before
363 # a like-named executable image (e.g. -lperl resolves to perlshr.exe
365 if ($lib !~ /\.[^:>\]]*$/) {
366 push(@variants,"${lib}shr","${lib}rtl","${lib}lib");
367 push(@variants,"lib$lib") if $lib !~ /[:>\]]/;
369 push(@variants,$lib);
370 warn "Looking for $lib\n" if $verbose;
371 foreach $variant (@variants) {
372 foreach $dir (@dirs) {
375 $name = "$dir$variant";
376 warn "\tChecking $name\n" if $verbose > 2;
377 if (-f ($test = VMS::Filespec::rmsexpand($name))) {
378 # It's got its own suffix, so we'll have to figure out the type
379 if ($test =~ /(?:$so|exe)$/i) { $type = 'sh'; }
380 elsif ($test =~ /(?:$lib_ext|olb)$/i) { $type = 'olb'; }
381 elsif ($test =~ /(?:$obj_ext|obj)$/i) {
382 warn "Note (probably harmless): "
383 ."Plain object file $test found in library list\n";
387 warn "Note (probably harmless): "
388 ."Unknown library type for $test; assuming shared\n";
392 elsif (-f ($test = VMS::Filespec::rmsexpand($name,$so)) or
393 -f ($test = VMS::Filespec::rmsexpand($name,'.exe'))) {
395 $name = $test unless $test =~ /exe;?\d*$/i;
397 elsif (not length($ctype) and # If we've got a lib already, don't bother
398 ( -f ($test = VMS::Filespec::rmsexpand($name,$lib_ext)) or
399 -f ($test = VMS::Filespec::rmsexpand($name,'.olb')))) {
401 $name = $test unless $test =~ /olb;?\d*$/i;
403 elsif (not length($ctype) and # If we've got a lib already, don't bother
404 ( -f ($test = VMS::Filespec::rmsexpand($name,$obj_ext)) or
405 -f ($test = VMS::Filespec::rmsexpand($name,'.obj')))) {
406 warn "Note (probably harmless): "
407 ."Plain object file $test found in library list\n";
409 $name = $test unless $test =~ /obj;?\d*$/i;
412 $ctype = $type; $cand = $name;
413 last if $ctype eq 'sh';
417 eval '$' . $ctype . "{'$cand'}++";
418 die "Error recording library: $@" if $@;
419 warn "\tFound as $cand (really $test), type $ctype\n" if $verbose > 1;
423 warn "Note (probably harmless): "
424 ."No library found for $lib\n";
427 @libs = sort keys %obj;
428 # This has to precede any other CRTLs, so just make it first
429 if ($olb{VAXCCURSE}) {
430 push(@libs,"$olb{VAXCCURSE}/Library");
431 delete $olb{VAXCCURSE};
433 push(@libs, map { "$_/Library" } sort keys %olb);
434 push(@libs, map { "$_/Share" } sort keys %sh);
435 $lib = join(' ',@libs);
437 $ldlib = $crtlstr ? "$lib $crtlstr" : $lib;
438 warn "Result:\n\tEXTRALIBS: $lib\n\tLDLOADLIBS: $ldlib\n" if $verbose;
439 wantarray ? ($lib, '', $ldlib, '') : $lib;
448 ExtUtils::Liblist - determine libraries to use and how to use them
452 C<require ExtUtils::Liblist;>
454 C<ExtUtils::Liblist::ext($self, $potential_libs, $verbose);>
458 This utility takes a list of libraries in the form C<-llib1 -llib2
459 -llib3> and prints out lines suitable for inclusion in an extension
460 Makefile. Extra library paths may be included with the form
461 C<-L/another/path> this will affect the searches for all subsequent
464 It returns an array of four scalar values: EXTRALIBS, BSLOADLIBS,
465 LDLOADLIBS, and LD_RUN_PATH. Some of these don't mean anything
466 on VMS and Win32. See the details about those platform specifics
469 Dependent libraries can be linked in one of three ways:
473 =item * For static extensions
475 by the ld command when the perl binary is linked with the extension
476 library. See EXTRALIBS below.
478 =item * For dynamic extensions
480 by the ld command when the shared object is built/linked. See
483 =item * For dynamic extensions
485 by the DynaLoader when the shared object is loaded. See BSLOADLIBS
492 List of libraries that need to be linked with when linking a perl
493 binary which includes this extension Only those libraries that
494 actually exist are included. These are written to a file and used
497 =head2 LDLOADLIBS and LD_RUN_PATH
499 List of those libraries which can or must be linked into the shared
500 library when created using ld. These may be static or dynamic
501 libraries. LD_RUN_PATH is a colon separated list of the directories
502 in LDLOADLIBS. It is passed as an environment variable to the process
503 that links the shared library.
507 List of those libraries that are needed but can be linked in
508 dynamically at run time on this platform. SunOS/Solaris does not need
509 this because ld records the information (from LDLOADLIBS) into the
510 object file. This list is used to create a .bs (bootstrap) file.
514 This module deals with a lot of system dependencies and has quite a
515 few architecture specific B<if>s in the code.
517 =head2 VMS implementation
519 The version of ext() which is executed under VMS differs from the
520 Unix-OS/2 version in several respects:
526 Input library and path specifications are accepted with or without the
527 C<-l> and C<-L> prefices used by Unix linkers. If neither prefix is
528 present, a token is considered a directory to search if it is in fact
529 a directory, and a library to search for otherwise. Authors who wish
530 their extensions to be portable to Unix or OS/2 should use the Unix
531 prefixes, since the Unix-OS/2 version of ext() requires them.
535 Wherever possible, shareable images are preferred to object libraries,
536 and object libraries to plain object files. In accordance with VMS
537 naming conventions, ext() looks for files named I<lib>shr and I<lib>rtl;
538 it also looks for I<lib>lib and libI<lib> to accomodate Unix conventions
539 used in some ported software.
543 For each library that is found, an appropriate directive for a linker options
544 file is generated. The return values are space-separated strings of
545 these directives, rather than elements used on the linker command line.
549 LDLOADLIBS contains both the libraries found based on C<$potential_libs> and
550 the CRTLs, if any, specified in Config.pm. EXTRALIBS contains just those
551 libraries found based on C<$potential_libs>. BSLOADLIBS and LD_RUN_PATH
556 In addition, an attempt is made to recognize several common Unix library
557 names, and filter them out or convert them to their VMS equivalents, as
560 In general, the VMS version of ext() should properly handle input from
561 extensions originally designed for a Unix or VMS environment. If you
562 encounter problems, or discover cases where the search could be improved,
565 =head2 Win32 implementation
567 The version of ext() which is executed under Win32 differs from the
568 Unix-OS/2 version in several respects:
574 Input library and path specifications are accepted with or without the
575 C<-l> and C<-L> prefices used by Unix linkers. C<-lfoo> specifies the
576 library C<libfoo.lib> (unless C<foo> already starts with C<lib>), and
577 C<-Ls:ome\dir> specifies a directory to look for the libraries that follow.
578 If neither prefix is present, a token is considered a directory to search
579 if it is in fact a directory, and a library to search for otherwise. The
580 C<$Config{lib_ext}> suffix will be appended to any entries that are not
581 directories and don't already have the suffix. Authors who wish their
582 extensions to be portable to Unix or OS/2 should use the Unix prefixes,
583 since the Unix-OS/2 version of ext() requires them.
587 Entries cannot be plain object files, as many Win32 compilers will
588 not handle object files in the place of libraries.
592 If C<$potential_libs> is empty, the return value will be empty.
593 Otherwise, the libraries specified by C<$Config{libs}> (see Config.pm)
594 will be appended to the list of C<$potential_libs>. The libraries
595 will be searched for in the directories specified in C<$potential_libs>
596 as well as in C<$Config{libpth}>. For each library that is found, a
597 space-separated list of fully qualified library pathnames is generated.
598 You may specify an entry that matches C</:nodefault/i> in
599 C<$potential_libs> to disable the appending of default libraries
600 found in C<$Config{libs}> (this should be only needed very rarely).
604 The libraries specified may be a mixture of static libraries and
605 import libraries (to link with DLLs). Since both kinds are used
606 pretty transparently on the win32 platform, we do not attempt to
607 distinguish between them.
611 LDLOADLIBS and EXTRALIBS are always identical under Win32, and BSLOADLIBS
612 and LD_RUN_PATH are always empty (this may change in future).
616 You must make sure that any paths and path components are properly
617 surrounded with double-quotes if they contain spaces. For example,
618 C<$potential_libs> could be (literally):
620 "-Lc:\Program Files\vc\lib" msvcrt.lib "la test\foo bar.lib"
622 Note how the first and last entries are protected by quotes in order
623 to protect the spaces.
630 L<ExtUtils::MakeMaker>