1 package ExtUtils::Mksymlists;
2 use strict qw[ subs refs ];
3 # no strict 'vars'; # until filehandles are exempted
7 use vars qw( @ISA @EXPORT $VERSION );
9 @EXPORT = '&Mksymlists';
10 $VERSION = substr q$Revision: 1.17 $, 10;
16 croak("Insufficient information specified to Mksymlists")
17 unless ( $spec{NAME} or
18 ($spec{FILE} and ($spec{DL_FUNCS} or $spec{FUNCLIST})) );
20 $spec{DL_VARS} = [] unless $spec{DL_VARS};
21 ($spec{FILE} = $spec{NAME}) =~ s/.*::// unless $spec{FILE};
22 $spec{FUNCLIST} = [] unless $spec{FUNCLIST};
23 $spec{DL_FUNCS} = { $spec{NAME} => [] }
24 unless ( ($spec{DL_FUNCS} and keys %{$spec{DL_FUNCS}}) or
26 if (defined $spec{DL_FUNCS}) {
28 foreach $package (keys %{$spec{DL_FUNCS}}) {
29 my($packprefix,$sym,$bootseen);
30 ($packprefix = $package) =~ s/\W/_/g;
31 foreach $sym (@{$spec{DL_FUNCS}->{$package}}) {
32 if ($sym =~ /^boot_/) {
33 push(@{$spec{FUNCLIST}},$sym);
36 else { push(@{$spec{FUNCLIST}},"XS_${packprefix}_$sym"); }
38 push(@{$spec{FUNCLIST}},"boot_$packprefix") unless $bootseen;
42 # We'll need this if we ever add any OS which uses mod2fname
43 # not as pseudo-builtin.
45 if (defined &DynaLoader::mod2fname and not $spec{DLBASE}) {
46 $spec{DLBASE} = DynaLoader::mod2fname([ split(/::/,$spec{NAME}) ]);
49 if ($osname eq 'aix') { _write_aix(\%spec); }
50 elsif ($osname eq 'VMS') { _write_vms(\%spec) }
51 elsif ($osname eq 'os2') { _write_os2(\%spec) }
52 elsif ($osname eq 'MSWin32') { _write_win32(\%spec) }
53 else { croak("Don't know how to create linker option file for $osname\n"); }
60 rename "$data->{FILE}.exp", "$data->{FILE}.exp_old";
62 open(EXP,">$data->{FILE}.exp")
63 or croak("Can't create $data->{FILE}.exp: $!\n");
64 print EXP join("\n",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
65 print EXP join("\n",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
73 my $threaded = ($Config::Config{archname} =~ /-thread/ ? " threaded" : "");
75 if (not $data->{DLBASE}) {
76 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
77 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
79 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
81 open(DEF,">$data->{FILE}.def")
82 or croak("Can't create $data->{FILE}.def: $!\n");
83 print DEF "LIBRARY '$data->{DLBASE}' INITINSTANCE TERMINSTANCE\n";
84 print DEF "DESCRIPTION 'Perl (v$]$threaded) module $data->{NAME} v$data->{VERSION}'\n";
85 print DEF "CODE LOADONCALL\n";
86 print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
87 print DEF "EXPORTS\n ";
88 print DEF join("\n ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
89 print DEF join("\n ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
90 if (%{$data->{IMPORTS}}) {
91 print DEF "IMPORTS\n";
93 while (($name, $exp)= each %{$data->{IMPORTS}}) {
94 print DEF " $name=$exp\n";
104 if (not $data->{DLBASE}) {
105 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
106 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
108 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
110 open(DEF,">$data->{FILE}.def")
111 or croak("Can't create $data->{FILE}.def: $!\n");
112 # put library name in quotes (it could be a keyword, like 'Alias')
113 if ($Config::Config{'cc'} !~ /^gcc/i) {
114 print DEF "LIBRARY \"$data->{DLBASE}\"\n";
116 print DEF "EXPORTS\n ";
118 # Export public symbols both with and without underscores to
119 # ensure compatibility between DLLs from different compilers
120 # NOTE: DynaLoader itself only uses the names without underscores,
121 # so this is only to cover the case when the extension DLL may be
122 # linked to directly from C. GSAR 97-07-10
123 if ($Config::Config{'cc'} =~ /^bcc/i) {
124 for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
125 push @syms, "_$_", "$_ = _$_";
129 for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
130 push @syms, "$_", "_$_ = $_";
133 print DEF join("\n ",@syms, "\n") if @syms;
134 if (%{$data->{IMPORTS}}) {
135 print DEF "IMPORTS\n";
137 while (($name, $exp)= each %{$data->{IMPORTS}}) {
138 print DEF " $name=$exp\n";
148 require Config; # a reminder for once we do $^O
149 require ExtUtils::XSSymSet;
151 my($isvax) = $Config::Config{'arch'} =~ /VAX/i;
152 my($set) = new ExtUtils::XSSymSet;
155 rename "$data->{FILE}.opt", "$data->{FILE}.opt_old";
157 open(OPT,">$data->{FILE}.opt")
158 or croak("Can't create $data->{FILE}.opt: $!\n");
160 # Options file declaring universal symbols
161 # Used when linking shareable image for dynamic extension,
162 # or when linking PerlShr into which we've added this package
163 # as a static extension
164 # We don't do anything to preserve order, so we won't relax
165 # the GSMATCH criteria for a dynamic extension
167 foreach $sym (@{$data->{FUNCLIST}}) {
168 my $safe = $set->addsym($sym);
169 if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
170 else { print OPT "SYMBOL_VECTOR=($safe=PROCEDURE)\n"; }
172 foreach $sym (@{$data->{DL_VARS}}) {
173 my $safe = $set->addsym($sym);
174 print OPT "PSECT_ATTR=${sym},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
175 if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
176 else { print OPT "SYMBOL_VECTOR=($safe=DATA)\n"; }
188 ExtUtils::Mksymlists - write linker options files for dynamic extension
192 use ExtUtils::Mksymlists;
193 Mksymlists({ NAME => $name ,
194 DL_VARS => [ $var1, $var2, $var3 ],
195 DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
196 $pkg2 => [ $func3 ] });
200 C<ExtUtils::Mksymlists> produces files used by the linker under some OSs
201 during the creation of shared libraries for dynamic extensions. It is
202 normally called from a MakeMaker-generated Makefile when the extension
203 is built. The linker option file is generated by calling the function
204 C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
205 It takes one argument, a list of key-value pairs, in which the following
212 This item specifies the name by which the linker knows the
213 extension, which may be different from the name of the
214 extension itself (for instance, some linkers add an '_' to the
215 name of the extension). If it is not specified, it is derived
216 from the NAME attribute. It is presently used only by OS2 and Win32.
220 This is identical to the DL_FUNCS attribute available via MakeMaker,
221 from which it is usually taken. Its value is a reference to an
222 associative array, in which each key is the name of a package, and
223 each value is an a reference to an array of function names which
224 should be exported by the extension. For instance, one might say
225 C<DL_FUNCS =E<gt> { Homer::Iliad =E<gt> [ qw(trojans greeks) ],
226 Homer::Odyssey =E<gt> [ qw(travellers family suitors) ] }>. The
227 function names should be identical to those in the XSUB code;
228 C<Mksymlists> will alter the names written to the linker option
229 file to match the changes made by F<xsubpp>. In addition, if
230 none of the functions in a list begin with the string B<boot_>,
231 C<Mksymlists> will add a bootstrap function for that package,
232 just as xsubpp does. (If a B<boot_E<lt>pkgE<gt>> function is
233 present in the list, it is passed through unchanged.) If
234 DL_FUNCS is not specified, it defaults to the bootstrap
235 function for the extension specified in NAME.
239 This is identical to the DL_VARS attribute available via MakeMaker,
240 and, like DL_FUNCS, it is usually specified via MakeMaker. Its
241 value is a reference to an array of variable names which should
242 be exported by the extension.
246 This key can be used to specify the name of the linker option file
247 (minus the OS-specific extension), if for some reason you do not
248 want to use the default value, which is the last word of the NAME
249 attribute (I<e.g.> for C<Tk::Canvas>, FILE defaults to C<Canvas>).
253 This provides an alternate means to specify function names to be
254 exported from the extension. Its value is a reference to an
255 array of function names to be exported by the extension. These
256 names are passed through unaltered to the linker options file.
257 Specifying a value for the FUNCLIST attribute supresses automatic
258 generation of the bootstrap function for the package. To still create
259 the bootstrap name you have to specify the package name in the
262 Mksymlists({ NAME => $name ,
263 FUNCLIST => [ $func1, $func2 ],
264 DL_FUNCS => { $pkg => [] } });
269 This attribute is used to specify names to be imported into the
270 extension. It is currently only used by OS/2 and Win32.
274 This gives the name of the extension (I<e.g.> C<Tk::Canvas>) for which
275 the linker option file will be produced.
279 When calling C<Mksymlists>, one should always specify the NAME
280 attribute. In most cases, this is all that's necessary. In
281 the case of unusual extensions, however, the other attributes
282 can be used to provide additional information to the linker.
286 Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>>
290 Last revised 14-Feb-1996, for Perl 5.002.