3 # Create the export list for perl.
5 # Needed by WIN32 and OS/2 for creating perl.dll,
6 # and by AIX for creating libperl.a when -Duseshrplib is in effect,
7 # and by VMS for creating perlshr.exe.
9 # Reads from information stored in
11 # %Config::Config (ie config.sh)
16 # miniperl.map (on OS/2)
17 # perl5.def (on OS/2; this is the old version of the file being made)
22 # plus long lists of function names hard-coded directly in this script.
24 # Writes the result to STDOUT.
26 # Normally this script is invoked from a makefile (e.g. win32/Makefile),
27 # which redirects STDOUT to a suitable file, such as:
35 BEGIN { unshift @INC, "lib" }
39 my %ARGS = (CCTYPE => 'MSVC', TARG_DIR => '');
45 sub process_cc_flags {
46 foreach (map {split /\s+/, $_} @_) {
47 $define{$1} = $2 // 1 if /^-D(\w+)(?:=(.+))?/;
53 if ($flag =~ /^(?:CC_FLAGS=)?(-D\w.*)/) {
55 } elsif ($flag =~ /^(CCTYPE|FILETYPE|PLATFORM|TARG_DIR)=(.+)$/) {
57 } elsif ($flag eq '--sort-fold') {
62 require "$ARGS{TARG_DIR}regen/embed_lib.pl";
65 my @PLATFORM = qw(aix win32 wince os2 netware vms test);
67 @PLATFORM{@PLATFORM} = ();
69 die "PLATFORM undefined, must be one of: @PLATFORM\n"
70 unless defined $ARGS{PLATFORM};
71 die "PLATFORM must be one of: @PLATFORM\n"
72 unless exists $PLATFORM{$ARGS{PLATFORM}};
75 # Is the following guard strictly necessary? Added during refactoring
76 # to keep the same behaviour when merging other code into here.
77 process_cc_flags(@Config{qw(ccflags optimize)})
78 if $ARGS{PLATFORM} ne 'win32' && $ARGS{PLATFORM} ne 'wince'
79 && $ARGS{PLATFORM} ne 'netware';
81 # Add the compile-time options that miniperl was built with to %define.
82 # On Win32 these are not the same options as perl itself will be built
83 # with since miniperl is built with a canned config (one of the win32/
84 # config_H.*) and none of the BUILDOPT's that are set in the makefiles,
85 # but they do include some #define's that are hard-coded in various
86 # source files and header files and don't include any BUILDOPT's that
87 # the user might have chosen to disable because the canned configs are
88 # minimal configs that don't include any of those options.
90 my @options = sort(Config::bincompat_options(), Config::non_bincompat_options());
91 print STDERR "Options: (@options)\n" unless $ARGS{PLATFORM} eq 'test';
92 $define{$_} = 1 foreach @options;
94 my %exportperlmalloc =
96 Perl_malloc => "malloc",
98 Perl_realloc => "realloc",
99 Perl_calloc => "calloc",
102 my $exportperlmalloc = $ARGS{PLATFORM} eq 'os2';
104 open(CFG, '<', 'config.h') || die "Cannot open config.h: $!\n";
106 $define{$1} = 1 if /^\s*\#\s*define\s+(MYMALLOC|MULTIPLICITY
107 |SPRINTF_RETURNS_STRLEN
109 |(?:PERL|USE|HAS)_\w+)\b/x;
113 # perl.h logic duplication begins
115 if ($define{USE_ITHREADS}) {
116 if (!$define{MULTIPLICITY}) {
117 $define{MULTIPLICITY} = 1;
121 $define{PERL_IMPLICIT_CONTEXT} ||=
122 $define{USE_ITHREADS} ||
123 $define{MULTIPLICITY} ;
125 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $^O ne 'darwin') {
126 $define{USE_REENTRANT_API} = 1;
129 # perl.h logic duplication ends
131 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
132 unless $ARGS{PLATFORM} eq 'test';
137 if ($ARGS{PLATFORM} eq 'os2') {
138 if (open my $fh, '<', 'perl5.def') {
140 last if /^\s*EXPORTS\b/;
143 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
144 # This allows skipping ordinals which were used in older versions
145 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
147 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
152 # All platforms export boot_DynaLoader unconditionally.
153 my %export = ( boot_DynaLoader => 1 );
156 foreach my $symbol (@_) {
157 ++$export{$symbol} unless exists $skip{$symbol};
162 # $hash is the hash that we're adding to. For one of our callers, it will
163 # actually be the skip hash but that doesn't affect the intent of what
164 # we're doing, as in that case we skip adding something to the skip hash
165 # for the second time.
167 my $file = $ARGS{TARG_DIR} . shift;
170 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
173 # All symbols have a Perl_ prefix because that's what embed.h sticks
174 # in front of them. The A?I?S?C? is strictly speaking wrong.
175 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
178 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
179 ++$hash->{$symbol} unless exists $skip{$var};
183 if ($ARGS{PLATFORM} ne 'os2') {
184 ++$skip{$_} foreach qw(
198 if ($ARGS{PLATFORM} eq 'vms') {
199 ++$skip{PL_statusvalue_posix};
200 # This is a wrapper if we have symlink, not a replacement
202 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
204 ++$skip{PL_statusvalue_vms};
205 if ($ARGS{PLATFORM} ne 'aix') {
206 ++$skip{$_} foreach qw(
218 if ($ARGS{PLATFORM} ne 'vms') {
219 # VMS does its own thing for these symbols.
220 ++$skip{$_} foreach qw(
221 PL_sig_handlers_initted
225 if ($ARGS{PLATFORM} ne 'win32') {
226 ++$skip{$_} foreach qw(
234 unless ($define{UNLINK_ALL_VERSIONS}) {
238 unless ($define{'DEBUGGING'}) {
239 ++$skip{$_} foreach qw(
253 if ($define{'PERL_IMPLICIT_SYS'}) {
254 ++$skip{$_} foreach qw(
258 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
259 ++$export{perl_clone_host} if $define{USE_ITHREADS};
262 ++$skip{$_} foreach qw(
277 unless ($define{'PERL_OLD_COPY_ON_WRITE'}) {
278 ++$skip{Perl_sv_setsv_cow};
281 unless ($define{'USE_REENTRANT_API'}) {
282 ++$skip{PL_reentrant_buffer};
285 if ($define{'MYMALLOC'}) {
294 unless ($define{USE_ITHREADS}) {
295 ++$skip{PL_malloc_mutex}
299 ++$skip{$_} foreach qw(
308 if ($define{'PERL_USE_SAFE_PUTENV'}) {
309 ++$skip{PL_use_safe_putenv};
312 unless ($define{'USE_ITHREADS'}) {
316 # USE_5005THREADS symbols. Kept as reference for easier removal
317 ++$skip{$_} foreach qw(
335 Perl_new_struct_thread
336 Perl_per_thread_magicals
344 unless ($define{'USE_ITHREADS'}) {
345 ++$skip{$_} foreach qw(
358 Perl_clone_params_del
359 Perl_clone_params_new
378 Perl_stashpv_hvname_match
379 Perl_regdupe_internal
384 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
385 ++$skip{$_} foreach qw(
394 Perl_load_module_nocontext
397 Perl_warner_nocontext
398 Perl_newSVpvf_nocontext
399 Perl_sv_catpvf_nocontext
400 Perl_sv_setpvf_nocontext
401 Perl_sv_catpvf_mg_nocontext
402 Perl_sv_setpvf_mg_nocontext
408 unless ($define{'PERL_NEED_APPCTX'}) {
412 unless ($define{'PERL_NEED_TIMESBASE'}) {
413 ++$skip{PL_timesbase};
416 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
417 ++$skip{PL_sv_serial};
420 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
421 ++$skip{PL_dumper_fd};
424 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
425 ++$skip{Perl_gv_SVadd};
428 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
429 ++$skip{Perl_my_sprintf};
432 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
433 ++$skip{PL_pidstatus};
436 unless ($define{'PERL_TRACK_MEMPOOL'}) {
437 ++$skip{PL_memory_debug_header};
440 unless ($define{PERL_MAD}) {
441 ++$skip{$_} foreach qw(
447 unless ($define{'MULTIPLICITY'}) {
448 ++$skip{$_} foreach qw(
450 PL_interp_size_5_16_0
454 unless ($define{'PERL_GLOBAL_STRUCT'}) {
455 ++$skip{PL_global_struct_size};
458 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
459 ++$skip{$_} foreach qw(
465 unless ($define{HAS_MMAP}) {
466 ++$skip{PL_mmap_page_size};
469 if ($define{HAS_SIGACTION}) {
470 ++$skip{PL_sig_trapped};
472 if ($ARGS{PLATFORM} eq 'vms') {
473 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
474 ++$skip{PL_sig_ignoring};
475 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
479 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
480 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
481 ++$skip{Perl_csighandler_init};
482 ++$skip{Perl_my_kill};
483 ++$skip{Perl_sig_to_vmscondition};
484 ++$skip{PL_sig_defaulting};
485 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
488 unless ($define{USE_LOCALE_COLLATE}) {
489 ++$skip{$_} foreach qw(
492 PL_collation_standard
496 Perl_sv_collxfrm_flags
500 unless ($define{USE_LOCALE_NUMERIC}) {
501 ++$skip{$_} foreach qw(
509 unless ($define{HAVE_INTERP_INTERN}) {
510 ++$skip{$_} foreach qw(
511 Perl_sys_intern_clear
518 if ($define{HAS_SIGNBIT}) {
519 ++$skip{Perl_signbit};
522 if ($define{'PERL_GLOBAL_STRUCT'}) {
523 readvar('perlvars.h', \%skip);
524 # This seems like the least ugly way to cope with the fact that PL_sh_path
525 # is mentioned in perlvar.h and globvar.sym, and always exported.
526 delete $skip{PL_sh_path};
527 ++$export{Perl_GetVars};
528 try_symbols(qw(PL_Vars PL_VarsPtr)) unless $ARGS{CCTYPE} eq 'GCC';
530 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
533 # functions from *.sym files
535 my @syms = qw(globvar.sym);
537 # Symbols that are the public face of the PerlIO layers implementation
538 # These are in _addition to_ the public face of the abstraction
539 # and need to be exported to allow XS modules to implement layers
554 PerlIOBase_setlinebuf
593 Perl_PerlIO_context_layers
600 Perl_PerlIO_get_bufsiz
606 Perl_PerlIO_set_ptrcnt
607 Perl_PerlIO_setlinebuf
615 if ($ARGS{PLATFORM} eq 'netware') {
616 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
619 if ($define{'USE_PERLIO'}) {
620 # Export the symols that make up the PerlIO abstraction, regardless
621 # of its implementation - read from a file
622 push @syms, 'perlio.sym';
624 # This part is then dependent on how the abstraction is implemented
625 if ($define{'USE_SFIO'}) {
626 # Old legacy non-stdio "PerlIO"
627 ++$skip{$_} foreach @layer_syms;
628 ++$skip{perlsio_binmode};
629 # SFIO defines most of the PerlIO routines as macros
630 # So undo most of what $perlio_sym has just done - d'oh !
631 # Perhaps it would be better to list the ones which do exist
633 ++$skip{$_} foreach qw(
684 Perl_PerlIO_get_bufsiz
690 Perl_PerlIO_set_ptrcnt
691 Perl_PerlIO_setlinebuf
704 # PerlIO with layers - export implementation
705 try_symbols(@layer_syms, 'perlsio_binmode');
709 # Skip the PerlIO layer symbols - although
710 # nothing should have exported them anyway.
711 ++$skip{$_} foreach @layer_syms;
712 ++$skip{$_} foreach qw(
719 PL_perlio_fd_refcnt_size
723 # Also do NOT add abstraction symbols from $perlio_sym
724 # abstraction is done as #define to stdio
725 # Remaining remnants that _may_ be functions are handled below.
728 ###############################################################################
730 # At this point all skip lists should be completed, as we are about to test
731 # many symbols against them.
735 my ($embed) = setup_embed($ARGS{TARG_DIR});
738 my ($flags, $retval, $func, @args) = @$_;
740 if ($flags =~ /[AX]/ && $flags !~ /[xm]/ || $flags =~ /b/) {
741 # public API, so export
743 # If a function is defined twice, for example before and after
744 # an #else, only export its name once. Important to do this test
745 # within the block, as the *first* definition may have flags which
746 # mean "don't export"
747 next if $seen{$func}++;
748 $func = "Perl_$func" if $flags =~ /[pbX]/;
749 ++$export{$func} unless exists $skip{$func};
755 my $syms = $ARGS{TARG_DIR} . $_;
756 open my $global, '<', $syms or die "failed to open $syms: $!\n";
757 # Functions already have a Perl_ prefix
758 # Variables need a PL_ prefix
759 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
761 next unless /^([A-Za-z].*)/;
762 my $symbol = "$prefix$1";
763 ++$export{$symbol} unless exists $skip{$symbol};
769 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
770 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
771 # XXX AIX seems to want the perlvars.h symbols, for some reason
772 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
773 readvar('perlvars.h', \%export);
777 unless ($define{'PERL_GLOBAL_STRUCT'}) {
778 readvar('perlvars.h', \%export);
780 unless ($define{MULTIPLICITY}) {
781 readvar('intrpvar.h', \%export);
785 # Oddities from PerlIO
786 # All have alternate implementations in perlio.c, so always exist.
787 # Should they be considered to be part of the API?
798 if ($ARGS{PLATFORM} eq 'win32') {
808 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
869 win32_getprotobynumber
965 elsif ($ARGS{PLATFORM} eq 'vms') {
970 Perl_csighandler_init
973 Perl_fileify_dirspec_ts
974 Perl_fileify_dirspec_utf8
975 Perl_fileify_dirspec_utf8_ts
1007 Perl_pathify_dirspec
1008 Perl_pathify_dirspec_ts
1009 Perl_pathify_dirspec_utf8
1010 Perl_pathify_dirspec_utf8_ts
1018 Perl_rmsexpand_utf8_ts
1020 Perl_sig_to_vmscondition
1024 Perl_tounixpath_utf8
1025 Perl_tounixpath_utf8_ts
1028 Perl_tounixspec_utf8
1029 Perl_tounixspec_utf8_ts
1033 Perl_tovmspath_utf8_ts
1037 Perl_tovmsspec_utf8_ts
1039 Perl_vms_case_tolerant
1050 elsif ($ARGS{PLATFORM} eq 'os2') {
1093 XS_Cwd_current_drive
1095 XS_Cwd_extLibpath_set
1099 XS_Cwd_sys_is_absolute
1100 XS_Cwd_sys_is_relative
1101 XS_Cwd_sys_is_rooted
1102 XS_DynaLoader_mod2fname
1103 XS_File__Copy_syscopy
1107 Perl_Process_Messages
1119 elsif ($ARGS{PLATFORM} eq 'netware') {
1246 fnInsertHashListAddrs
1258 # When added this code was only run for Win32 and WinCE
1259 # Currently only Win32 links static extensions into the shared library.
1260 # The WinCE makefile doesn't appear to support static extensions, so this code
1261 # can't have any effect there.
1262 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1263 # list of dynamic extensions, and the rules to build them)
1264 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1265 # static extensions with -fPIC, but links them to perl, not libperl.so
1266 # The VMS build scripts don't yet implement static extensions at all.
1268 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1269 # records of type boot_module for statically linked modules (except Dynaloader)
1270 my $static_ext = $Config{static_ext} // "";
1271 $static_ext =~ s/\//__/g;
1272 $static_ext =~ s/\bDynaLoader\b//;
1273 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1274 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1277 if ($ARGS{PLATFORM} eq 'os2') {
1278 my (%mapped, @missing);
1279 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1280 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1281 close MAP or die 'Cannot close miniperl.map';
1283 @missing = grep { !exists $mapped{$_} }
1285 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1286 delete $export{$_} foreach @missing;
1289 ###############################################################################
1291 # Now all symbols should be defined because next we are going to output them.
1293 # Start with platform specific headers:
1295 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1296 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1297 : "perl$Config{api_revision}$Config{api_version}";
1298 print "LIBRARY $dll\n";
1299 # The DESCRIPTION module definition file statement is not supported
1301 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1302 print "DESCRIPTION 'Perl interpreter'\n";
1306 elsif ($ARGS{PLATFORM} eq 'os2') {
1307 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1308 $v .= '-thread' if $Config{archname} =~ /-thread/;
1309 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1310 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1311 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1312 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1313 print <<"---EOP---";
1314 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1318 DATA LOADONCALL NONSHARED MULTIPLE
1322 elsif ($ARGS{PLATFORM} eq 'aix') {
1323 my $OSVER = `uname -v`;
1325 my $OSREL = `uname -r`;
1327 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1333 elsif ($ARGS{PLATFORM} eq 'netware') {
1334 if ($ARGS{FILETYPE} eq 'def') {
1335 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1336 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1343 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1344 foreach my $symbol (@symbols) {
1345 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1346 print "\t$symbol\n";
1348 elsif ($ARGS{PLATFORM} eq 'os2') {
1349 printf qq( %-31s \@%s\n),
1350 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1351 printf qq( %-31s \@%s\n),
1352 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1353 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1354 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1356 elsif ($ARGS{PLATFORM} eq 'netware') {
1357 print "\t$symbol,\n";
1363 # Then platform specific footers.
1365 if ($ARGS{PLATFORM} eq 'os2') {
1370 Perl_OS2_handler_install
1372 ; LAST_ORDINAL=$sym_ord