applied suggested patch; removed $VERSION = $VERSION hack
[p5sagit/p5-mst-13.2.git] / ext / DynaLoader / DynaLoader_pm.PL
CommitLineData
03c9e98c 1
2use Config;
3
4sub to_string {
5 my ($value) = @_;
001ad4e0 6 $value =~ s/\\/\\\\/g;
03c9e98c 7 $value =~ s/'/\\'/g;
8 return "'$value'";
9}
10
11unlink "DynaLoader.pm" if -f "DynaLoader.pm";
12open OUT, ">DynaLoader.pm" or die $!;
13print OUT <<'EOT';
14
15# Generated from DynaLoader.pm.PL (resolved %Config::Config values)
16
a0d0e21e 17package DynaLoader;
18
8e07c86e 19# And Gandalf said: 'Many folk like to know beforehand what is to
20# be set on the table; but those who have laboured to prepare the
21# feast like to keep their secret; for wonder makes the words of
22# praise louder.'
23
24# (Quote from Tolkien sugested by Anno Siegel.)
25#
26# See pod text at end of file for documentation.
27# See also ext/DynaLoader/README in source tree for other information.
28#
29# Tim.Bunce@ig.co.uk, August 1994
30
9426adcd 31$VERSION = "1.03"; # avoid typo warning
dc848c6f 32
dc848c6f 33require AutoLoader;
34*AUTOLOAD = \&AutoLoader::AUTOLOAD;
8e07c86e 35
fb73857a 36# The following require can't be removed during maintenance
37# releases, sadly, because of the risk of buggy code that does
38# require Carp; Carp::croak "..."; without brackets dying
39# if Carp hasn't been loaded in earlier compile time. :-(
40# We'll let those bugs get found on the development track.
41require Carp if $] < 5.00450;
42
43
8e07c86e 44# enable debug/trace messages from DynaLoader perl code
45$dl_debug = $ENV{PERL_DL_DEBUG} || 0 unless defined $dl_debug;
46
ff7f3c60 47#
48# Flags to alter dl_load_file behaviour. Assigned bits:
49# 0x01 make symbols available for linking later dl_load_file's.
50# (only known to work on Solaris 2 using dlopen(RTLD_GLOBAL))
f86702cc 51# (ignored under VMS; effect is built-in to image linking)
ff7f3c60 52#
53# This is called as a class method $module->dl_load_flags. The
54# definition here will be inherited and result on "default" loading
55# behaviour unless a sub-class of DynaLoader defines its own version.
56#
57
58sub dl_load_flags { 0x00 }
59
03c9e98c 60# ($dl_dlext, $dlsrc)
61# = @Config::Config{'dlext', 'dlsrc'};
62EOT
63
64print OUT " (\$dl_dlext, \$dlsrc) = (",
65 to_string($Config::Config{'dlext'}), ",",
66 to_string($Config::Config{'dlsrc'}), ")\n;" ;
ff7f3c60 67
03c9e98c 68print OUT <<'EOT';
8e07c86e 69
70# Some systems need special handling to expand file specifications
71# (VMS support by Charles Bailey <bailey@HMIVAX.HUMGEN.UPENN.EDU>)
72# See dl_expandspec() for more details. Should be harmless but
73# inefficient to define on systems that don't need it.
d404d5bf 74$do_expand = $Is_VMS = $^O eq 'VMS';
cd39f2b6 75$Is_MacOS = $^O eq 'MacOS';
8e07c86e 76
77@dl_require_symbols = (); # names of symbols we need
78@dl_resolve_using = (); # names of files to link with
79@dl_library_path = (); # path to look for files
ff7f3c60 80@dl_librefs = (); # things we have loaded
81@dl_modules = (); # Modules we have loaded
8e07c86e 82
83# This is a fix to support DLD's unfortunate desire to relink -lc
84@dl_resolve_using = dl_findfile('-lc') if $dlsrc eq "dl_dld.xs";
85
86# Initialise @dl_library_path with the 'standard' library path
87# for this platform as determined by Configure
03c9e98c 88
89# push(@dl_library_path, split(' ', $Config::Config{'libpth'});
90EOT
91
92print OUT "push(\@dl_library_path, split(' ', ",
93 to_string($Config::Config{'libpth'}), "));\n";
94
95print OUT <<'EOT';
8e07c86e 96
5cf1d1f1 97# Add to @dl_library_path any extra directories we can gather
98# from environment variables.
cd39f2b6 99if ($Is_MacOS) {
100 push(@dl_library_path, split(/,/, $ENV{LD_LIBRARY_PATH}))
101 if exists $ENV{LD_LIBRARY_PATH};
102} else {
103 push(@dl_library_path, split(/:/, $ENV{$Config::Config{ldlibpthname}}))
104 if exists $Config::Config{ldlibpthname} &&
105 $Config::Config{ldlibpthname} ne '' &&
106 exists $ENV{$Config::Config{ldlibpthname}} ;;
107 push(@dl_library_path, split(/:/, $ENV{$Config::Config{ldlibpthname}}))
108 if exists $Config::Config{ldlibpthname} &&
109 $Config::Config{ldlibpthname} ne '' &&
110 exists $ENV{$Config::Config{ldlibpthname}} ;;
5cf1d1f1 111# E.g. HP-UX supports both its native SHLIB_PATH *and* LD_LIBRARY_PATH.
8e07c86e 112push(@dl_library_path, split(/:/, $ENV{LD_LIBRARY_PATH}))
5cf1d1f1 113 if exists $ENV{LD_LIBRARY_PATH};
cd39f2b6 114}
8e07c86e 115
116# No prizes for guessing why we don't say 'bootstrap DynaLoader;' here.
bb3913c7 117boot_DynaLoader('DynaLoader') if defined(&boot_DynaLoader) &&
118 !defined(&dl_load_file);
8e07c86e 119
120
121if ($dl_debug) {
122 print STDERR "DynaLoader.pm loaded (@INC, @dl_library_path)\n";
123 print STDERR "DynaLoader not linked into this perl\n"
124 unless defined(&boot_DynaLoader);
125}
126
1271; # End of main code
128
129
fb73857a 130sub croak { require Carp; Carp::croak(@_) }
131
9426adcd 132sub bootstrap_inherit {
133 my $module = $_[0];
134 local *isa = *{"$module\::ISA"};
135 local @isa = (@isa, 'DynaLoader');
136 # Cannot goto due to delocalization. Will report errors on a wrong line?
137 bootstrap(@_);
138}
139
8e07c86e 140# The bootstrap function cannot be autoloaded (without complications)
141# so we define it here:
142
143sub bootstrap {
144 # use local vars to enable $module.bs script to edit values
145 local(@args) = @_;
146 local($module) = $args[0];
147 local(@dirs, $file);
148
fb73857a 149 unless ($module) {
150 require Carp;
151 Carp::confess("Usage: DynaLoader::bootstrap(module)");
152 }
8e07c86e 153
154 # A common error on platforms which don't support dynamic loading.
155 # Since it's fatal and potentially confusing we give a detailed message.
fb73857a 156 croak("Can't load module $module, dynamic loading not available in this perl.\n".
8e07c86e 157 " (You may need to build a new perl executable which either supports\n".
158 " dynamic loading or has the $module module statically linked into it.)\n")
159 unless defined(&dl_load_file);
160
161 my @modparts = split(/::/,$module);
162 my $modfname = $modparts[-1];
163
164 # Some systems have restrictions on files names for DLL's etc.
165 # mod2fname returns appropriate file base name (typically truncated)
166 # It may also edit @modparts if required.
167 $modfname = &mod2fname(\@modparts) if defined &mod2fname;
168
cd39f2b6 169 my $modpname = join(($Is_MacOS ? ':' : '/'),@modparts);
8e07c86e 170
171 print STDERR "DynaLoader::bootstrap for $module ",
cd39f2b6 172 ($Is_MacOS
173 ? "(auto/$modpname/$modfname.$dl_dlext)\n" :
174 "(:auto:$modpname:$modfname.$dl_dlext)\n")
175 if $dl_debug;
8e07c86e 176
177 foreach (@INC) {
54d6a3b3 178 chop($_ = VMS::Filespec::unixpath($_)) if $Is_VMS;
cd39f2b6 179 my $dir;
180 if ($Is_MacOS) {
181 chop $_ if /:$/;
182 $dir = "$_:auto:$modpname";
183 } else {
184 $dir = "$_/auto/$modpname";
185 }
8e07c86e 186 next unless -d $dir; # skip over uninteresting directories
187
188 # check for common cases to avoid autoload of dl_findfile
cd39f2b6 189 my $try = $Is_MacOS ? "$dir:$modfname.$dl_dlext" : "$dir/$modfname.$dl_dlext";
fb73857a 190 last if $file = ($do_expand) ? dl_expandspec($try) : (-f $try && $try);
8e07c86e 191
192 # no luck here, save dir for possible later dl_findfile search
fb73857a 193 push @dirs, $dir;
8e07c86e 194 }
195 # last resort, let dl_findfile have a go in all known locations
fb73857a 196 $file = dl_findfile(map("-L$_",@dirs,@INC), $modfname) unless $file;
8e07c86e 197
fb73857a 198 croak("Can't locate loadable object for module $module in \@INC (\@INC contains: @INC)")
199 unless $file; # wording similar to error from 'require'
8e07c86e 200
201 my $bootname = "boot_$module";
202 $bootname =~ s/\W/_/g;
203 @dl_require_symbols = ($bootname);
204
205 # Execute optional '.bootstrap' perl script for this module.
206 # The .bs file can be used to configure @dl_resolve_using etc to
207 # match the needs of the individual module on this architecture.
208 my $bs = $file;
3f45a6dd 209 $bs =~ s/(\.\w+)?(;\d*)?$/\.bs/; # look for .bs 'beside' the library
8e07c86e 210 if (-s $bs) { # only read file if it's not empty
d404d5bf 211 print STDERR "BS: $bs ($^O, $dlsrc)\n" if $dl_debug;
8e07c86e 212 eval { do $bs; };
213 warn "$bs: $@\n" if $@;
214 }
215
216 # Many dynamic extension loading problems will appear to come from
217 # this section of code: XYZ failed at line 123 of DynaLoader.pm.
218 # Often these errors are actually occurring in the initialisation
219 # C code of the extension XS file. Perl reports the error as being
220 # in this perl code simply because this was the last perl code
221 # it executed.
222
ff7f3c60 223 my $libref = dl_load_file($file, $module->dl_load_flags) or
549a6b10 224 croak("Can't load '$file' for module $module: ".dl_error());
8e07c86e 225
ff7f3c60 226 push(@dl_librefs,$libref); # record loaded object
227
8e07c86e 228 my @unresolved = dl_undef_symbols();
fb73857a 229 if (@unresolved) {
230 require Carp;
231 Carp::carp("Undefined symbols present after loading $file: @unresolved\n");
232 }
8e07c86e 233
234 my $boot_symbol_ref = dl_find_symbol($libref, $bootname) or
fb73857a 235 croak("Can't find '$bootname' symbol in $file\n");
8e07c86e 236
237 my $xs = dl_install_xsub("${module}::bootstrap", $boot_symbol_ref, $file);
238
ff7f3c60 239 push(@dl_modules, $module); # record loaded module
240
8e07c86e 241 # See comment block above
242 &$xs(@args);
243}
244
245
fb73857a 246#sub _check_file { # private utility to handle dl_expandspec vs -f tests
247# my($file) = @_;
248# return $file if (!$do_expand && -f $file); # the common case
249# return $file if ( $do_expand && ($file=dl_expandspec($file)));
250# return undef;
251#}
8e07c86e 252
253
254# Let autosplit and the autoloader deal with these functions:
255__END__
256
257
258sub dl_findfile {
259 # Read ext/DynaLoader/DynaLoader.doc for detailed information.
260 # This function does not automatically consider the architecture
261 # or the perl library auto directories.
262 my (@args) = @_;
263 my (@dirs, $dir); # which directories to search
264 my (@found); # full paths to real files we have found
03c9e98c 265EOT
266
267print OUT ' my $dl_ext= ' . to_string($Config::Config{'dlext'}) .
268 "; # \$Config::Config{'dlext'} suffix for perl extensions\n";
269print OUT ' my $dl_so = ' . to_string($Config::Config{'so'}) .
270 "; # \$Config::Config{'so'} suffix for shared libraries\n";
271
272print OUT <<'EOT';
8e07c86e 273
274 print STDERR "dl_findfile(@args)\n" if $dl_debug;
275
276 # accumulate directories but process files as they appear
277 arg: foreach(@args) {
278 # Special fast case: full filepath requires no search
54d6a3b3 279 if ($Is_VMS && m%[:>/\]]% && -f $_) {
280 push(@found,dl_expandspec(VMS::Filespec::vmsify($_)));
281 last arg unless wantarray;
282 next;
283 }
cd39f2b6 284 elsif ($Is_MacOS) {
285 if (m/:/ && -f $_) {
286 push(@found,$_);
287 last arg unless wantarray;
288 }
289 }
54d6a3b3 290 elsif (m:/: && -f $_ && !$do_expand) {
8e07c86e 291 push(@found,$_);
292 last arg unless wantarray;
293 next;
294 }
295
296 # Deal with directories first:
297 # Using a -L prefix is the preferred option (faster and more robust)
298 if (m:^-L:) { s/^-L//; push(@dirs, $_); next; }
299
cd39f2b6 300 if ($Is_MacOS) {
301 # Otherwise we try to try to spot directories by a heuristic
302 # (this is a more complicated issue than it first appears)
303 if (m/:/ && -d $_) { push(@dirs, $_); next; }
304 # Only files should get this far...
305 my(@names, $name); # what filenames to look for
306 s/^-l//;
307 push(@names, $_);
308 foreach $dir (@dirs, @dl_library_path) {
309 next unless -d $dir;
310 $dir =~ s/^([^:]+)$/:$1/;
311 $dir =~ s/:$//;
312 foreach $name (@names) {
313 my($file) = "$dir:$name";
314 print STDERR " checking in $dir for $name\n" if $dl_debug;
315 if (-f $file) {
316 push(@found, $file);
317 next arg; # no need to look any further
318 }
319 }
320 }
321 next;
322 }
323
8e07c86e 324 # Otherwise we try to try to spot directories by a heuristic
325 # (this is a more complicated issue than it first appears)
326 if (m:/: && -d $_) { push(@dirs, $_); next; }
327
328 # VMS: we may be using native VMS directry syntax instead of
329 # Unix emulation, so check this as well
54d6a3b3 330 if ($Is_VMS && /[:>\]]/ && -d $_) { push(@dirs, $_); next; }
8e07c86e 331
332 # Only files should get this far...
333 my(@names, $name); # what filenames to look for
334 if (m:-l: ) { # convert -lname to appropriate library name
335 s/-l//;
336 push(@names,"lib$_.$dl_so");
337 push(@names,"lib$_.a");
338 } else { # Umm, a bare name. Try various alternatives:
339 # these should be ordered with the most likely first
d404d5bf 340 push(@names,"$_.$dl_ext") unless m/\.$dl_ext$/o;
8e07c86e 341 push(@names,"$_.$dl_so") unless m/\.$dl_so$/o;
342 push(@names,"lib$_.$dl_so") unless m:/:;
8e07c86e 343 push(@names,"$_.a") if !m/\.a$/ and $dlsrc eq "dl_dld.xs";
344 push(@names, $_);
345 }
346 foreach $dir (@dirs, @dl_library_path) {
347 next unless -d $dir;
54d6a3b3 348 chop($dir = VMS::Filespec::unixpath($dir)) if $Is_VMS;
8e07c86e 349 foreach $name (@names) {
350 my($file) = "$dir/$name";
351 print STDERR " checking in $dir for $name\n" if $dl_debug;
fb73857a 352 $file = ($do_expand) ? dl_expandspec($file) : (-f $file && $file);
353 #$file = _check_file($file);
8e07c86e 354 if ($file) {
355 push(@found, $file);
356 next arg; # no need to look any further
357 }
358 }
359 }
360 }
361 if ($dl_debug) {
362 foreach(@dirs) {
363 print STDERR " dl_findfile ignored non-existent directory: $_\n" unless -d $_;
364 }
365 print STDERR "dl_findfile found: @found\n";
366 }
367 return $found[0] unless wantarray;
368 @found;
369}
370
371
372sub dl_expandspec {
373 my($spec) = @_;
374 # Optional function invoked if DynaLoader.pm sets $do_expand.
375 # Most systems do not require or use this function.
376 # Some systems may implement it in the dl_*.xs file in which case
377 # this autoload version will not be called but is harmless.
378
379 # This function is designed to deal with systems which treat some
380 # 'filenames' in a special way. For example VMS 'Logical Names'
381 # (something like unix environment variables - but different).
382 # This function should recognise such names and expand them into
383 # full file paths.
384 # Must return undef if $spec is invalid or file does not exist.
385
386 my $file = $spec; # default output to input
387
d404d5bf 388 if ($Is_VMS) { # dl_expandspec should be defined in dl_vms.xs
fb73857a 389 require Carp;
4633a7c4 390 Carp::croak("dl_expandspec: should be defined in XS file!\n");
8e07c86e 391 } else {
392 return undef unless -f $file;
393 }
394 print STDERR "dl_expandspec($spec) => $file\n" if $dl_debug;
395 $file;
396}
397
ff7f3c60 398sub dl_find_symbol_anywhere
399{
400 my $sym = shift;
401 my $libref;
402 foreach $libref (@dl_librefs) {
403 my $symref = dl_find_symbol($libref,$sym);
404 return $symref if $symref;
405 }
406 return undef;
407}
8e07c86e 408
3b35bae3 409=head1 NAME
410
411DynaLoader - Dynamically load C libraries into Perl code
412
ff7f3c60 413dl_error(), dl_findfile(), dl_expandspec(), dl_load_file(), dl_find_symbol(), dl_find_symbol_anywhere(), dl_undef_symbols(), dl_install_xsub(), dl_load_flags(), bootstrap() - routines used by DynaLoader modules
3b35bae3 414
415=head1 SYNOPSIS
416
8e07c86e 417 package YourPackage;
3b35bae3 418 require DynaLoader;
c2960299 419 @ISA = qw(... DynaLoader ...);
8e07c86e 420 bootstrap YourPackage;
3b35bae3 421
ff7f3c60 422 # optional method for 'global' loading
423 sub dl_load_flags { 0x01 }
424
3b35bae3 425
426=head1 DESCRIPTION
427
c2960299 428This document defines a standard generic interface to the dynamic
3b35bae3 429linking mechanisms available on many platforms. Its primary purpose is
430to implement automatic dynamic loading of Perl modules.
431
c2960299 432This document serves as both a specification for anyone wishing to
433implement the DynaLoader for a new platform and as a guide for
434anyone wishing to use the DynaLoader directly in an application.
435
3b35bae3 436The DynaLoader is designed to be a very simple high-level
437interface that is sufficiently general to cover the requirements
438of SunOS, HP-UX, NeXT, Linux, VMS and other platforms.
439
c2960299 440It is also hoped that the interface will cover the needs of OS/2, NT
441etc and also allow pseudo-dynamic linking (using C<ld -A> at runtime).
3b35bae3 442
443It must be stressed that the DynaLoader, by itself, is practically
444useless for accessing non-Perl libraries because it provides almost no
445Perl-to-C 'glue'. There is, for example, no mechanism for calling a C
03c9e98c 446library function or supplying arguments. A C::DynaLib module
90248788 447is available from CPAN sites which performs that function for some
448common system types.
3b35bae3 449
450DynaLoader Interface Summary
451
452 @dl_library_path
453 @dl_resolve_using
454 @dl_require_symbols
455 $dl_debug
ff7f3c60 456 @dl_librefs
457 @dl_modules
3b35bae3 458 Implemented in:
459 bootstrap($modulename) Perl
460 @filepaths = dl_findfile(@names) Perl
ff7f3c60 461 $flags = $modulename->dl_load_flags Perl
462 $symref = dl_find_symbol_anywhere($symbol) Perl
3b35bae3 463
ff7f3c60 464 $libref = dl_load_file($filename, $flags) C
3b35bae3 465 $symref = dl_find_symbol($libref, $symbol) C
466 @symbols = dl_undef_symbols() C
467 dl_install_xsub($name, $symref [, $filename]) C
468 $message = dl_error C
469
470=over 4
471
472=item @dl_library_path
473
474The standard/default list of directories in which dl_findfile() will
475search for libraries etc. Directories are searched in order:
476$dl_library_path[0], [1], ... etc
477
478@dl_library_path is initialised to hold the list of 'normal' directories
479(F</usr/lib>, etc) determined by B<Configure> (C<$Config{'libpth'}>). This should
480ensure portability across a wide range of platforms.
481
482@dl_library_path should also be initialised with any other directories
483that can be determined from the environment at runtime (such as
484LD_LIBRARY_PATH for SunOS).
485
486After initialisation @dl_library_path can be manipulated by an
487application using push and unshift before calling dl_findfile().
488Unshift can be used to add directories to the front of the search order
489either to save search time or to override libraries with the same name
490in the 'normal' directories.
491
492The load function that dl_load_file() calls may require an absolute
493pathname. The dl_findfile() function and @dl_library_path can be
494used to search for and return the absolute pathname for the
495library/object that you wish to load.
496
497=item @dl_resolve_using
498
499A list of additional libraries or other shared objects which can be
500used to resolve any undefined symbols that might be generated by a
501later call to load_file().
502
503This is only required on some platforms which do not handle dependent
7a2e2cd6 504libraries automatically. For example the Socket Perl extension
505library (F<auto/Socket/Socket.so>) contains references to many socket
506functions which need to be resolved when it's loaded. Most platforms
507will automatically know where to find the 'dependent' library (e.g.,
508F</usr/lib/libsocket.so>). A few platforms need to be told the
509location of the dependent library explicitly. Use @dl_resolve_using
510for this.
3b35bae3 511
512Example usage:
513
514 @dl_resolve_using = dl_findfile('-lsocket');
515
516=item @dl_require_symbols
517
518A list of one or more symbol names that are in the library/object file
519to be dynamically loaded. This is only required on some platforms.
520
ff7f3c60 521=item @dl_librefs
522
523An array of the handles returned by successful calls to dl_load_file(),
524made by bootstrap, in the order in which they were loaded.
525Can be used with dl_find_symbol() to look for a symbol in any of
526the loaded files.
527
528=item @dl_modules
529
530An array of module (package) names that have been bootstrap'ed.
531
3b35bae3 532=item dl_error()
533
534Syntax:
535
536 $message = dl_error();
537
538Error message text from the last failed DynaLoader function. Note
539that, similar to errno in unix, a successful function call does not
540reset this message.
541
542Implementations should detect the error as soon as it occurs in any of
543the other functions and save the corresponding message for later
544retrieval. This will avoid problems on some platforms (such as SunOS)
545where the error message is very temporary (e.g., dlerror()).
546
547=item $dl_debug
548
549Internal debugging messages are enabled when $dl_debug is set true.
550Currently setting $dl_debug only affects the Perl side of the
551DynaLoader. These messages should help an application developer to
552resolve any DynaLoader usage problems.
553
554$dl_debug is set to C<$ENV{'PERL_DL_DEBUG'}> if defined.
555
556For the DynaLoader developer/porter there is a similar debugging
557variable added to the C code (see dlutils.c) and enabled if Perl was
558built with the B<-DDEBUGGING> flag. This can also be set via the
559PERL_DL_DEBUG environment variable. Set to 1 for minimal information or
560higher for more.
561
562=item dl_findfile()
563
564Syntax:
565
566 @filepaths = dl_findfile(@names)
567
568Determine the full paths (including file suffix) of one or more
569loadable files given their generic names and optionally one or more
570directories. Searches directories in @dl_library_path by default and
571returns an empty list if no files were found.
572
573Names can be specified in a variety of platform independent forms. Any
574names in the form B<-lname> are converted into F<libname.*>, where F<.*> is
575an appropriate suffix for the platform.
576
577If a name does not already have a suitable prefix and/or suffix then
578the corresponding file will be searched for by trying combinations of
579prefix and suffix appropriate to the platform: "$name.o", "lib$name.*"
580and "$name".
581
582If any directories are included in @names they are searched before
c2960299 583@dl_library_path. Directories may be specified as B<-Ldir>. Any other
584names are treated as filenames to be searched for.
3b35bae3 585
586Using arguments of the form C<-Ldir> and C<-lname> is recommended.
587
588Example:
589
590 @dl_resolve_using = dl_findfile(qw(-L/usr/5lib -lposix));
591
592
593=item dl_expandspec()
594
595Syntax:
596
597 $filepath = dl_expandspec($spec)
598
599Some unusual systems, such as VMS, require special filename handling in
600order to deal with symbolic names for files (i.e., VMS's Logical Names).
601
602To support these systems a dl_expandspec() function can be implemented
603either in the F<dl_*.xs> file or code can be added to the autoloadable
c2960299 604dl_expandspec() function in F<DynaLoader.pm>. See F<DynaLoader.pm> for
605more information.
3b35bae3 606
607=item dl_load_file()
608
609Syntax:
610
ff7f3c60 611 $libref = dl_load_file($filename, $flags)
3b35bae3 612
613Dynamically load $filename, which must be the path to a shared object
614or library. An opaque 'library reference' is returned as a handle for
615the loaded object. Returns undef on error.
616
ff7f3c60 617The $flags argument to alters dl_load_file behaviour.
618Assigned bits:
619
620 0x01 make symbols available for linking later dl_load_file's.
621 (only known to work on Solaris 2 using dlopen(RTLD_GLOBAL))
f86702cc 622 (ignored under VMS; this is a normal part of image linking)
ff7f3c60 623
3b35bae3 624(On systems that provide a handle for the loaded object such as SunOS
625and HPUX, $libref will be that handle. On other systems $libref will
626typically be $filename or a pointer to a buffer containing $filename.
627The application should not examine or alter $libref in any way.)
628
ff7f3c60 629This is the function that does the real work. It should use the
630current values of @dl_require_symbols and @dl_resolve_using if required.
3b35bae3 631
632 SunOS: dlopen($filename)
633 HP-UX: shl_load($filename)
634 Linux: dld_create_reference(@dl_require_symbols); dld_link($filename)
635 NeXT: rld_load($filename, @dl_resolve_using)
636 VMS: lib$find_image_symbol($filename,$dl_require_symbols[0])
637
ff7f3c60 638(The dlopen() function is also used by Solaris and some versions of
639Linux, and is a common choice when providing a "wrapper" on other
640mechanisms as is done in the OS/2 port.)
641
642=item dl_loadflags()
643
644Syntax:
645
646 $flags = dl_loadflags $modulename;
647
648Designed to be a method call, and to be overridden by a derived class
649(i.e. a class which has DynaLoader in its @ISA). The definition in
650DynaLoader itself returns 0, which produces standard behavior from
651dl_load_file().
3b35bae3 652
653=item dl_find_symbol()
654
655Syntax:
656
657 $symref = dl_find_symbol($libref, $symbol)
658
659Return the address of the symbol $symbol or C<undef> if not found. If the
660target system has separate functions to search for symbols of different
661types then dl_find_symbol() should search for function symbols first and
662then other types.
663
664The exact manner in which the address is returned in $symref is not
665currently defined. The only initial requirement is that $symref can
666be passed to, and understood by, dl_install_xsub().
667
668 SunOS: dlsym($libref, $symbol)
669 HP-UX: shl_findsym($libref, $symbol)
670 Linux: dld_get_func($symbol) and/or dld_get_symbol($symbol)
671 NeXT: rld_lookup("_$symbol")
672 VMS: lib$find_image_symbol($libref,$symbol)
673
674
ff7f3c60 675=item dl_find_symbol_anywhere()
676
677Syntax:
678
679 $symref = dl_find_symbol_anywhere($symbol)
680
681Applies dl_find_symbol() to the members of @dl_librefs and returns
682the first match found.
683
3b35bae3 684=item dl_undef_symbols()
685
686Example
687
688 @symbols = dl_undef_symbols()
689
690Return a list of symbol names which remain undefined after load_file().
691Returns C<()> if not known. Don't worry if your platform does not provide
c2960299 692a mechanism for this. Most do not need it and hence do not provide it,
693they just return an empty list.
3b35bae3 694
695
696=item dl_install_xsub()
697
698Syntax:
699
700 dl_install_xsub($perl_name, $symref [, $filename])
701
702Create a new Perl external subroutine named $perl_name using $symref as
703a pointer to the function which implements the routine. This is simply
704a direct call to newXSUB(). Returns a reference to the installed
705function.
706
707The $filename parameter is used by Perl to identify the source file for
708the function if required by die(), caller() or the debugger. If
709$filename is not defined then "DynaLoader" will be used.
710
711
1fef88e7 712=item bootstrap()
3b35bae3 713
714Syntax:
715
716bootstrap($module)
717
718This is the normal entry point for automatic dynamic loading in Perl.
719
720It performs the following actions:
721
722=over 8
723
724=item *
725
726locates an auto/$module directory by searching @INC
727
728=item *
729
730uses dl_findfile() to determine the filename to load
731
732=item *
733
734sets @dl_require_symbols to C<("boot_$module")>
735
736=item *
737
738executes an F<auto/$module/$module.bs> file if it exists
739(typically used to add to @dl_resolve_using any files which
740are required to load the module on the current platform)
741
742=item *
743
ff7f3c60 744calls dl_load_flags() to determine how to load the file.
745
746=item *
747
3b35bae3 748calls dl_load_file() to load the file
749
750=item *
751
752calls dl_undef_symbols() and warns if any symbols are undefined
753
754=item *
755
756calls dl_find_symbol() for "boot_$module"
757
758=item *
759
760calls dl_install_xsub() to install it as "${module}::bootstrap"
761
762=item *
763
8e07c86e 764calls &{"${module}::bootstrap"} to bootstrap the module (actually
765it uses the function reference returned by dl_install_xsub for speed)
3b35bae3 766
767=back
768
769=back
770
771
772=head1 AUTHOR
773
c2960299 774Tim Bunce, 11 August 1994.
775
3b35bae3 776This interface is based on the work and comments of (in no particular
777order): Larry Wall, Robert Sanders, Dean Roehrich, Jeff Okamoto, Anno
c2960299 778Siegel, Thomas Neumann, Paul Marquess, Charles Bailey, myself and others.
3b35bae3 779
780Larry Wall designed the elegant inherited bootstrap mechanism and
781implemented the first Perl 5 dynamic loader using it.
782
ff7f3c60 783Solaris global loading added by Nick Ing-Simmons with design/coding
784assistance from Tim Bunce, January 1996.
785
3b35bae3 786=cut
03c9e98c 787EOT
788
789close OUT or die $!;
790