1 package ExtUtils::Liblist;
3 # Broken out of MakeMaker from version 4.11
5 $VERSION = substr q$Revision: 1.2201 $, 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 print STDOUT "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
37 # its home is in <distribution>/ext/util
39 my(@searchpath); # from "-L/path" entries in $potential_libs
40 my(@libpath) = split " ", $Config{'libpth'};
41 my(@ldloadlibs, @bsloadlibs, @extralibs, @ld_run_path, %ld_run_path_seen);
42 my($fullname, $thislib, $thispth, @fullname);
43 my($pwd) = cwd(); # from Cwd.pm
46 foreach $thislib (split ' ', $potential_libs){
48 # Handle possible linker path arguments.
49 if ($thislib =~ s/^(-[LR])//){ # save path flag type
52 print STDOUT "$ptype$thislib ignored, directory does not exist\n"
56 unless ($self->file_name_is_absolute($thislib)) {
57 print STDOUT "Warning: $ptype$thislib changed to $ptype$pwd/$thislib\n";
58 $thislib = $self->catdir($pwd,$thislib);
60 push(@searchpath, $thislib);
61 push(@extralibs, "$ptype$thislib");
62 push(@ldloadlibs, "$ptype$thislib");
66 # Handle possible library arguments.
67 unless ($thislib =~ s/^-l//){
68 print STDOUT "Unrecognized argument in LIBS ignored: '$thislib'\n";
73 foreach $thispth (@searchpath, @libpath){
75 # Try to find the full name of the library. We need this to
76 # determine whether it's a dynamically-loadable library or not.
77 # This tends to be subject to various os-specific quirks.
78 # For gcc-2.6.2 on linux (March 1995), DLD can not load
79 # .sa libraries, with the exception of libm.sa, so we
80 # deliberately skip them.
82 $self->lsdir($thispth,"^\Qlib$thislib.$so.\E[0-9]+")){
83 # Take care that libfoo.so.10 wins against libfoo.so.9.
84 # Compare two libraries to find the most recent version
85 # number. E.g. if you have libfoo.so.9.0.7 and
86 # libfoo.so.10.1, first convert all digits into two
87 # decimal places. Then we'll add ".00" to the shorter
88 # strings so that we're comparing strings of equal length
89 # Thus we'll compare libfoo.so.09.07.00 with
90 # libfoo.so.10.01.00. Some libraries might have letters
91 # in the version. We don't know what they mean, but will
92 # try to skip them gracefully -- we'll set any letter to
93 # '0'. Finally, sort in reverse so we can take the
96 #TODO: iterate through the directory instead of sorting
98 $fullname = "$thispth/" .
101 $ma =~ tr/A-Za-z/0/s;
102 $ma =~ s/\b(\d)\b/0$1/g;
103 $mb =~ tr/A-Za-z/0/s;
104 $mb =~ s/\b(\d)\b/0$1/g;
105 while (length($ma) < length($mb)) { $ma .= ".00"; }
106 while (length($mb) < length($ma)) { $mb .= ".00"; }
107 # Comparison deliberately backwards
108 $mb cmp $ma;} @fullname)[0];
109 } elsif (-f ($fullname="$thispth/lib$thislib.$so")
110 && (($Config{'dlsrc'} ne "dl_dld.xs") || ($thislib eq "m"))){
111 } elsif (-f ($fullname="$thispth/lib${thislib}_s$Config_libext")
112 && ($thislib .= "_s") ){ # we must explicitly use _s version
113 } elsif (-f ($fullname="$thispth/lib$thislib$Config_libext")){
114 } elsif (-f ($fullname="$thispth/$thislib$Config_libext")){
115 } elsif (-f ($fullname="$thispth/Slib$thislib$Config_libext")){
116 } elsif ($^O eq 'dgux'
117 && -l ($fullname="$thispth/lib$thislib$Config_libext")
118 && readlink($fullname) =~ /^elink:/) {
119 # Some of DG's libraries look like misconnected symbolic
120 # links, but development tools can follow them. (They
123 # libm.a -> elink:${SDE_PATH:-/usr}/sde/\
124 # ${TARGET_BINARY_INTERFACE:-m88kdgux}/usr/lib/libm.a
126 # , the compilation tools expand the environment variables.)
128 print STDOUT "$thislib not found in $thispth\n" if $verbose;
131 print STDOUT "'-l$thislib' found at $fullname\n" if $verbose;
132 my($fullnamedir) = dirname($fullname);
133 push @ld_run_path, $fullnamedir unless $ld_run_path_seen{$fullnamedir}++;
137 # Now update library lists
139 # what do we know about this library...
140 my $is_dyna = ($fullname !~ /\Q$Config_libext\E$/);
141 my $in_perl = ($libs =~ /\B-l\Q$ {thislib}\E\b/s);
143 # Do not add it into the list if it is already linked in
144 # with the main perl executable.
145 # We have to special-case the NeXT, because math and ndbm
146 # are both in libsys_s
148 ($Config{'osname'} eq 'next' &&
149 ($thislib eq 'm' || $thislib eq 'ndbm')) ){
150 push(@extralibs, "-l$thislib");
153 # We might be able to load this archive file dynamically
154 if ( ($Config{'dlsrc'} =~ /dl_next/ && $Config{'osvers'} lt '4_0')
155 || ($Config{'dlsrc'} =~ /dl_dld/) )
157 # We push -l$thislib instead of $fullname because
158 # it avoids hardwiring a fixed path into the .bs file.
159 # Mkbootstrap will automatically add dl_findfile() to
160 # the .bs file if it sees a name in the -l format.
161 # USE THIS, when dl_findfile() is fixed:
162 # push(@bsloadlibs, "-l$thislib");
163 # OLD USE WAS while checking results against old_extliblist
164 push(@bsloadlibs, "$fullname");
167 # For SunOS4, do not add in this shared library if
168 # it is already linked in the main perl executable
169 push(@ldloadlibs, "-l$thislib")
170 unless ($in_perl and $^O eq 'sunos');
172 push(@ldloadlibs, "-l$thislib");
175 last; # found one here so don't bother looking further
177 print STDOUT "Note (probably harmless): "
178 ."No library found for -l$thislib\n"
181 return ('','','','') unless $found;
182 ("@extralibs", "@bsloadlibs", "@ldloadlibs",join(":",@ld_run_path));
186 my($self, $potential_libs, $verbose) = @_;
188 # If user did not supply a list, we punt.
189 # (caller should probably use the list in $Config{libs})
190 return ("", "", "", "") unless $potential_libs;
192 my($so) = $Config{'so'};
193 my($libs) = $Config{'libs'};
194 my($libpth) = $Config{'libpth'};
195 my($libext) = $Config{'lib_ext'} || ".lib";
197 if ($libs and $potential_libs !~ /:nodefault/i) {
198 # If Config.pm defines a set of default libs, we always
199 # tack them on to the user-supplied list, unless the user
200 # specified :nodefault
202 $potential_libs .= " " if $potential_libs;
203 $potential_libs .= $libs;
205 print STDOUT "Potential libraries are '$potential_libs':\n" if $verbose;
207 # compute $extralibs from $potential_libs
209 my(@searchpath); # from "-L/path" entries in $potential_libs
210 my(@libpath) = split " ", $libpth;
212 my($fullname, $thislib, $thispth);
213 my($pwd) = cwd(); # from Cwd.pm
217 foreach $thislib (split ' ', $potential_libs){
219 # Handle possible linker path arguments.
220 if ($thislib =~ s/^-L// and not -d $thislib) {
221 print STDOUT "-L$thislib ignored, directory does not exist\n"
225 elsif (-d $thislib) {
226 unless ($self->file_name_is_absolute($thislib)) {
227 print STDOUT "Warning: -L$thislib changed to -L$pwd/$thislib\n";
228 $thislib = $self->catdir($pwd,$thislib);
230 push(@searchpath, $thislib);
234 # Handle possible library arguments.
236 $thislib .= $libext if $thislib !~ /\Q$libext\E$/i;
239 foreach $thispth (@searchpath, @libpath){
240 unless (-f ($fullname="$thispth\\$thislib")) {
241 print STDOUT "$thislib not found in $thispth\n" if $verbose;
244 print STDOUT "'$thislib' found at $fullname\n" if $verbose;
247 push(@extralibs, $fullname);
250 print STDOUT "Note (probably harmless): "
251 ."No library found for '$thislib'\n"
254 return ('','','','') unless $found;
255 $lib = join(' ',@extralibs);
256 print "Result: $lib\n" if $verbose;
257 wantarray ? ($lib, '', $lib, '') : $lib;
262 my($self, $potential_libs,$verbose) = @_;
263 return ('', '', '', '') unless $potential_libs;
265 my(@dirs,@libs,$dir,$lib,%sh,%olb,%obj);
267 my($so,$lib_ext,$obj_ext) = @Config{'so','lib_ext','obj_ext'};
268 # List of common Unix library names and there VMS equivalents
269 # (VMS equivalent of '' indicates that the library is automatially
270 # searched by the linker, and should be skipped here.)
271 my %libmap = ( 'm' => '', 'f77' => '', 'F77' => '', 'V77' => '', 'c' => '',
272 'malloc' => '', 'crypt' => '', 'resolv' => '', 'c_s' => '',
273 'socket' => '', 'X11' => 'DECW$XLIBSHR',
274 'Xt' => 'DECW$XTSHR', 'Xm' => 'DECW$XMLIBSHR',
275 'Xmu' => 'DECW$XMULIBSHR');
276 if ($Config{'vms_cc_type'} ne 'decc') { $libmap{'curses'} = 'VAXCCURSE'; }
278 print STDOUT "Potential libraries are '$potential_libs'\n" if $verbose;
280 # First, sort out directories and library names in the input
281 foreach $lib (split ' ',$potential_libs) {
282 push(@dirs,$1), next if $lib =~ /^-L(.*)/;
283 push(@dirs,$lib), next if $lib =~ /[:>\]]$/;
284 push(@dirs,$lib), next if -d $lib;
285 push(@libs,$1), next if $lib =~ /^-l(.*)/;
288 push(@dirs,split(' ',$Config{'libpth'}));
290 # Now make sure we've got VMS-syntax absolute directory specs
291 # (We don't, however, check whether someone's hidden a relative
292 # path in a logical name.)
293 foreach $dir (@dirs) {
295 print STDOUT "Skipping nonexistent Directory $dir\n" if $verbose > 1;
299 print STDOUT "Resolving directory $dir\n" if $verbose;
300 if ($self->file_name_is_absolute($dir)) { $dir = $self->fixpath($dir,1); }
301 else { $dir = $self->catdir($cwd,$dir); }
303 @dirs = grep { length($_) } @dirs;
304 unshift(@dirs,''); # Check each $lib without additions first
306 LIB: foreach $lib (@libs) {
307 if (exists $libmap{$lib}) {
308 next unless length $libmap{$lib};
309 $lib = $libmap{$lib};
312 my(@variants,$variant,$name,$test,$cand);
315 # If we don't have a file type, consider it a possibly abbreviated name and
316 # check for common variants. We try these first to grab libraries before
317 # a like-named executable image (e.g. -lperl resolves to perlshr.exe
319 if ($lib !~ /\.[^:>\]]*$/) {
320 push(@variants,"${lib}shr","${lib}rtl","${lib}lib");
321 push(@variants,"lib$lib") if $lib !~ /[:>\]]/;
323 push(@variants,$lib);
324 print STDOUT "Looking for $lib\n" if $verbose;
325 foreach $variant (@variants) {
326 foreach $dir (@dirs) {
329 $name = "$dir$variant";
330 print "\tChecking $name\n" if $verbose > 2;
331 if (-f ($test = VMS::Filespec::rmsexpand($name))) {
332 # It's got its own suffix, so we'll have to figure out the type
333 if ($test =~ /(?:$so|exe)$/i) { $type = 'sh'; }
334 elsif ($test =~ /(?:$lib_ext|olb)$/i) { $type = 'olb'; }
335 elsif ($test =~ /(?:$obj_ext|obj)$/i) {
336 print STDOUT "Note (probably harmless): "
337 ."Plain object file $test found in library list\n";
341 print STDOUT "Note (probably harmless): "
342 ."Unknown library type for $test; assuming shared\n";
346 elsif (-f ($test = VMS::Filespec::rmsexpand($name,$so)) or
347 -f ($test = VMS::Filespec::rmsexpand($name,'.exe'))) {
349 $name = $test unless $test =~ /exe;?\d*$/i;
351 elsif (not length($ctype) and # If we've got a lib already, don't bother
352 ( -f ($test = VMS::Filespec::rmsexpand($name,$lib_ext)) or
353 -f ($test = VMS::Filespec::rmsexpand($name,'.olb')))) {
355 $name = $test unless $test =~ /olb;?\d*$/i;
357 elsif (not length($ctype) and # If we've got a lib already, don't bother
358 ( -f ($test = VMS::Filespec::rmsexpand($name,$obj_ext)) or
359 -f ($test = VMS::Filespec::rmsexpand($name,'.obj')))) {
360 print STDOUT "Note (probably harmless): "
361 ."Plain object file $test found in library list\n";
363 $name = $test unless $test =~ /obj;?\d*$/i;
366 $ctype = $type; $cand = $name;
367 last if $ctype eq 'sh';
371 eval '$' . $ctype . "{'$cand'}++";
372 die "Error recording library: $@" if $@;
373 print STDOUT "\tFound as $cand (really $test), type $ctype\n" if $verbose > 1;
377 print STDOUT "Note (probably harmless): "
378 ."No library found for $lib\n";
381 @libs = sort keys %obj;
382 # This has to precede any other CRTLs, so just make it first
383 if ($olb{VAXCCURSE}) {
384 push(@libs,"$olb{VAXCCURSE}/Library");
385 delete $olb{VAXCCURSE};
387 push(@libs, map { "$_/Library" } sort keys %olb);
388 push(@libs, map { "$_/Share" } sort keys %sh);
389 $lib = join(' ',@libs);
390 print "Result: $lib\n" if $verbose;
391 wantarray ? ($lib, '', $lib, '') : $lib;
400 ExtUtils::Liblist - determine libraries to use and how to use them
404 C<require ExtUtils::Liblist;>
406 C<ExtUtils::Liblist::ext($self, $potential_libs, $verbose);>
410 This utility takes a list of libraries in the form C<-llib1 -llib2
411 -llib3> and prints out lines suitable for inclusion in an extension
412 Makefile. Extra library paths may be included with the form
413 C<-L/another/path> this will affect the searches for all subsequent
416 It returns an array of four scalar values: EXTRALIBS, BSLOADLIBS,
417 LDLOADLIBS, and LD_RUN_PATH. Some of these don't mean anything
418 on VMS and Win32. See the details about those platform specifics
421 Dependent libraries can be linked in one of three ways:
425 =item * For static extensions
427 by the ld command when the perl binary is linked with the extension
428 library. See EXTRALIBS below.
430 =item * For dynamic extensions
432 by the ld command when the shared object is built/linked. See
435 =item * For dynamic extensions
437 by the DynaLoader when the shared object is loaded. See BSLOADLIBS
444 List of libraries that need to be linked with when linking a perl
445 binary which includes this extension Only those libraries that
446 actually exist are included. These are written to a file and used
449 =head2 LDLOADLIBS and LD_RUN_PATH
451 List of those libraries which can or must be linked into the shared
452 library when created using ld. These may be static or dynamic
453 libraries. LD_RUN_PATH is a colon separated list of the directories
454 in LDLOADLIBS. It is passed as an environment variable to the process
455 that links the shared library.
459 List of those libraries that are needed but can be linked in
460 dynamically at run time on this platform. SunOS/Solaris does not need
461 this because ld records the information (from LDLOADLIBS) into the
462 object file. This list is used to create a .bs (bootstrap) file.
466 This module deals with a lot of system dependencies and has quite a
467 few architecture specific B<if>s in the code.
469 =head2 VMS implementation
471 The version of ext() which is executed under VMS differs from the
472 Unix-OS/2 version in several respects:
478 Input library and path specifications are accepted with or without the
479 C<-l> and C<-L> prefices used by Unix linkers. If neither prefix is
480 present, a token is considered a directory to search if it is in fact
481 a directory, and a library to search for otherwise. Authors who wish
482 their extensions to be portable to Unix or OS/2 should use the Unix
483 prefixes, since the Unix-OS/2 version of ext() requires them.
487 Wherever possible, shareable images are preferred to object libraries,
488 and object libraries to plain object files. In accordance with VMS
489 naming conventions, ext() looks for files named I<lib>shr and I<lib>rtl;
490 it also looks for I<lib>lib and libI<lib> to accomodate Unix conventions
491 used in some ported software.
495 For each library that is found, an appropriate directive for a linker options
496 file is generated. The return values are space-separated strings of
497 these directives, rather than elements used on the linker command line.
501 LDLOADLIBS and EXTRALIBS are always identical under VMS, and BSLOADLIBS
502 and LD_RIN_PATH are always empty.
506 In addition, an attempt is made to recognize several common Unix library
507 names, and filter them out or convert them to their VMS equivalents, as
510 In general, the VMS version of ext() should properly handle input from
511 extensions originally designed for a Unix or VMS environment. If you
512 encounter problems, or discover cases where the search could be improved,
515 =head2 Win32 implementation
517 The version of ext() which is executed under Win32 differs from the
518 Unix-OS/2 version in several respects:
524 Input library and path specifications are accepted with or without the
525 C<-l> and C<-L> prefices used by Unix linkers. C<-lfoo> specifies the
526 library C<foo.lib> and C<-Ls:ome\dir> specifies a directory to look for
527 the libraries that follow. If neither prefix is present, a token is
528 considered a directory to search if it is in fact a directory, and a
529 library to search for otherwise. The C<$Config{lib_ext}> suffix will
530 be appended to any entries that are not directories and don't already
531 have the suffix. Authors who wish their extensions to be portable to
532 Unix or OS/2 should use the Unix prefixes, since the Unix-OS/2 version
533 of ext() requires them.
537 Entries cannot be plain object files, as many Win32 compilers will
538 not handle object files in the place of libraries.
542 If C<$potential_libs> is empty, the return value will be empty.
543 Otherwise, the libraries specified by C<$Config{libs}> (see Config.pm)
544 will be appended to the list of C<$potential_libs>. The libraries
545 will be searched for in the directories specified in C<$potential_libs>
546 as well as in C<$Config{libpth}>. For each library that is found, a
547 space-separated list of fully qualified library pathnames is generated.
548 You may specify an entry that matches C</:nodefault/i> in
549 C<$potential_libs> to disable the appending of default libraries
550 found in C<$Config{libs}> (this should be only needed very rarely).
554 The libraries specified may be a mixture of static libraries and
555 import libraries (to link with DLLs). Since both kinds are used
556 pretty transparently on the win32 platform, we do not attempt to
557 distinguish between them.
561 LDLOADLIBS and EXTRALIBS are always identical under Win32, and BSLOADLIBS
562 and LD_RUN_PATH are always empty (this may change in future).
569 L<ExtUtils::MakeMaker>