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
108 |(?:PERL|USE|HAS)_\w+)\b/x;
112 # perl.h logic duplication begins
114 if ($define{PERL_IMPLICIT_SYS}) {
115 $define{PL_OP_SLAB_ALLOC} = 1;
118 if ($define{USE_ITHREADS}) {
119 if (!$define{MULTIPLICITY}) {
120 $define{MULTIPLICITY} = 1;
124 $define{PERL_IMPLICIT_CONTEXT} ||=
125 $define{USE_ITHREADS} ||
126 $define{MULTIPLICITY} ;
128 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $^O ne 'darwin') {
129 $define{USE_REENTRANT_API} = 1;
132 # perl.h logic duplication ends
134 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
135 unless $ARGS{PLATFORM} eq 'test';
140 if ($ARGS{PLATFORM} eq 'os2') {
141 if (open my $fh, '<', 'perl5.def') {
143 last if /^\s*EXPORTS\b/;
146 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
147 # This allows skipping ordinals which were used in older versions
148 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
150 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
155 # All platforms export boot_DynaLoader unconditionally.
156 my %export = ( boot_DynaLoader => 1 );
159 foreach my $symbol (@_) {
160 ++$export{$symbol} unless exists $skip{$symbol};
165 # $hash is the hash that we're adding to. For one of our callers, it will
166 # actually be the skip hash but that doesn't affect the intent of what
167 # we're doing, as in that case we skip adding something to the skip hash
168 # for the second time.
170 my $file = $ARGS{TARG_DIR} . shift;
173 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
176 # All symbols have a Perl_ prefix because that's what embed.h sticks
177 # in front of them. The A?I?S?C? is strictly speaking wrong.
178 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
181 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
182 ++$hash->{$symbol} unless exists $skip{$var};
186 if ($ARGS{PLATFORM} ne 'os2') {
187 ++$skip{$_} foreach qw(
201 if ($ARGS{PLATFORM} eq 'vms') {
202 ++$skip{PL_statusvalue_posix};
203 # This is a wrapper if we have symlink, not a replacement
205 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
207 ++$skip{PL_statusvalue_vms};
208 if ($ARGS{PLATFORM} ne 'aix') {
209 ++$skip{$_} foreach qw(
221 if ($ARGS{PLATFORM} ne 'vms') {
222 # VMS does its own thing for these symbols.
223 ++$skip{$_} foreach qw(
224 PL_sig_handlers_initted
228 if ($ARGS{PLATFORM} ne 'win32') {
229 ++$skip{$_} foreach qw(
237 unless ($define{UNLINK_ALL_VERSIONS}) {
241 unless ($define{'DEBUGGING'}) {
242 ++$skip{$_} foreach qw(
257 if ($define{'PERL_IMPLICIT_SYS'}) {
258 ++$skip{$_} foreach qw(
262 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
263 ++$export{perl_clone_host} if $define{USE_ITHREADS};
266 ++$skip{$_} foreach qw(
281 unless ($define{'PERL_OLD_COPY_ON_WRITE'}) {
282 ++$skip{Perl_sv_setsv_cow};
285 unless ($define{'USE_REENTRANT_API'}) {
286 ++$skip{PL_reentrant_buffer};
289 if ($define{'MYMALLOC'}) {
298 unless ($define{USE_ITHREADS}) {
299 ++$skip{PL_malloc_mutex}
303 ++$skip{$_} foreach qw(
312 if ($define{'PERL_USE_SAFE_PUTENV'}) {
313 ++$skip{PL_use_safe_putenv};
316 unless ($define{'USE_ITHREADS'}) {
320 # USE_5005THREADS symbols. Kept as reference for easier removal
321 ++$skip{$_} foreach qw(
339 Perl_new_struct_thread
340 Perl_per_thread_magicals
348 unless ($define{'USE_ITHREADS'}) {
349 ++$skip{$_} foreach qw(
362 Perl_clone_params_del
363 Perl_clone_params_new
382 Perl_stashpv_hvname_match
383 Perl_regdupe_internal
388 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
389 ++$skip{$_} foreach qw(
398 Perl_load_module_nocontext
401 Perl_warner_nocontext
402 Perl_newSVpvf_nocontext
403 Perl_sv_catpvf_nocontext
404 Perl_sv_setpvf_nocontext
405 Perl_sv_catpvf_mg_nocontext
406 Perl_sv_setpvf_mg_nocontext
412 unless ($define{'PL_OP_SLAB_ALLOC'}) {
413 ++$skip{$_} foreach qw(
422 unless ($define{'PERL_DEBUG_READONLY_OPS'}) {
423 ++$skip{$_} foreach qw(
429 unless ($define{'PERL_NEED_APPCTX'}) {
433 unless ($define{'PERL_NEED_TIMESBASE'}) {
434 ++$skip{PL_timesbase};
437 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
438 ++$skip{PL_sv_serial};
441 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
442 ++$skip{PL_dumper_fd};
445 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
446 ++$skip{Perl_gv_SVadd};
449 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
450 ++$skip{Perl_my_sprintf};
453 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
454 ++$skip{PL_pidstatus};
457 unless ($define{'PERL_TRACK_MEMPOOL'}) {
458 ++$skip{PL_memory_debug_header};
461 unless ($define{PERL_MAD}) {
462 ++$skip{$_} foreach qw(
468 unless ($define{'MULTIPLICITY'}) {
469 ++$skip{$_} foreach qw(
471 PL_interp_size_5_16_0
475 unless ($define{'PERL_GLOBAL_STRUCT'}) {
476 ++$skip{PL_global_struct_size};
479 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
480 ++$skip{$_} foreach qw(
486 unless ($define{HAS_MMAP}) {
487 ++$skip{PL_mmap_page_size};
490 if ($define{HAS_SIGACTION}) {
491 ++$skip{PL_sig_trapped};
493 if ($ARGS{PLATFORM} eq 'vms') {
494 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
495 ++$skip{PL_sig_ignoring};
499 unless ($define{USE_LOCALE_COLLATE}) {
500 ++$skip{$_} foreach qw(
503 PL_collation_standard
507 Perl_sv_collxfrm_flags
511 unless ($define{USE_LOCALE_NUMERIC}) {
512 ++$skip{$_} foreach qw(
520 unless ($define{HAVE_INTERP_INTERN}) {
521 ++$skip{$_} foreach qw(
522 Perl_sys_intern_clear
529 if ($define{HAS_SIGNBIT}) {
530 ++$skip{Perl_signbit};
533 if ($define{'PERL_GLOBAL_STRUCT'}) {
534 readvar('perlvars.h', \%skip);
535 # This seems like the least ugly way to cope with the fact that PL_sh_path
536 # is mentioned in perlvar.h and globvar.sym, and always exported.
537 delete $skip{PL_sh_path};
538 ++$export{Perl_GetVars};
539 try_symbols(qw(PL_Vars PL_VarsPtr)) unless $ARGS{CCTYPE} eq 'GCC';
541 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
544 # functions from *.sym files
546 my @syms = qw(globvar.sym);
548 # Symbols that are the public face of the PerlIO layers implementation
549 # These are in _addition to_ the public face of the abstraction
550 # and need to be exported to allow XS modules to implement layers
565 PerlIOBase_setlinebuf
604 Perl_PerlIO_context_layers
611 Perl_PerlIO_get_bufsiz
617 Perl_PerlIO_set_ptrcnt
618 Perl_PerlIO_setlinebuf
626 if ($ARGS{PLATFORM} eq 'netware') {
627 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
630 if ($define{'USE_PERLIO'}) {
631 # Export the symols that make up the PerlIO abstraction, regardless
632 # of its implementation - read from a file
633 push @syms, 'perlio.sym';
635 # This part is then dependent on how the abstraction is implemented
636 if ($define{'USE_SFIO'}) {
637 # Old legacy non-stdio "PerlIO"
638 ++$skip{$_} foreach @layer_syms;
639 ++$skip{perlsio_binmode};
640 # SFIO defines most of the PerlIO routines as macros
641 # So undo most of what $perlio_sym has just done - d'oh !
642 # Perhaps it would be better to list the ones which do exist
644 ++$skip{$_} foreach qw(
695 Perl_PerlIO_get_bufsiz
701 Perl_PerlIO_set_ptrcnt
702 Perl_PerlIO_setlinebuf
715 # PerlIO with layers - export implementation
716 try_symbols(@layer_syms, 'perlsio_binmode');
720 # Skip the PerlIO layer symbols - although
721 # nothing should have exported them anyway.
722 ++$skip{$_} foreach @layer_syms;
723 ++$skip{$_} foreach qw(
730 PL_perlio_fd_refcnt_size
734 # Also do NOT add abstraction symbols from $perlio_sym
735 # abstraction is done as #define to stdio
736 # Remaining remnants that _may_ be functions are handled below.
739 ###############################################################################
741 # At this point all skip lists should be completed, as we are about to test
742 # many symbols against them.
746 my ($embed) = setup_embed($ARGS{TARG_DIR});
749 my ($flags, $retval, $func, @args) = @$_;
751 if ($flags =~ /[AX]/ && $flags !~ /[xm]/ || $flags =~ /b/) {
752 # public API, so export
754 # If a function is defined twice, for example before and after
755 # an #else, only export its name once. Important to do this test
756 # within the block, as the *first* definition may have flags which
757 # mean "don't export"
758 next if $seen{$func}++;
759 $func = "Perl_$func" if $flags =~ /[pbX]/;
760 ++$export{$func} unless exists $skip{$func};
766 my $syms = $ARGS{TARG_DIR} . $_;
767 open my $global, '<', $syms or die "failed to open $syms: $!\n";
768 # Functions already have a Perl_ prefix
769 # Variables need a PL_ prefix
770 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
772 next unless /^([A-Za-z].*)/;
773 my $symbol = "$prefix$1";
774 ++$export{$symbol} unless exists $skip{$symbol};
780 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
781 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
782 # XXX AIX seems to want the perlvars.h symbols, for some reason
783 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
784 readvar('perlvars.h', \%export);
788 unless ($define{'PERL_GLOBAL_STRUCT'}) {
789 readvar('perlvars.h', \%export);
791 unless ($define{MULTIPLICITY}) {
792 readvar('intrpvar.h', \%export);
796 # Oddities from PerlIO
797 # All have alternate implementations in perlio.c, so always exist.
798 # Should they be considered to be part of the API?
809 if ($ARGS{PLATFORM} eq 'win32') {
821 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
882 win32_getprotobynumber
978 elsif ($ARGS{PLATFORM} eq 'vms') {
983 Perl_csighandler_init
986 Perl_fileify_dirspec_ts
987 Perl_fileify_dirspec_utf8
988 Perl_fileify_dirspec_utf8_ts
1020 Perl_pathify_dirspec
1021 Perl_pathify_dirspec_ts
1022 Perl_pathify_dirspec_utf8
1023 Perl_pathify_dirspec_utf8_ts
1031 Perl_rmsexpand_utf8_ts
1033 Perl_sig_to_vmscondition
1037 Perl_tounixpath_utf8
1038 Perl_tounixpath_utf8_ts
1041 Perl_tounixspec_utf8
1042 Perl_tounixspec_utf8_ts
1046 Perl_tovmspath_utf8_ts
1050 Perl_tovmsspec_utf8_ts
1052 Perl_vms_case_tolerant
1063 elsif ($ARGS{PLATFORM} eq 'os2') {
1106 XS_Cwd_current_drive
1108 XS_Cwd_extLibpath_set
1112 XS_Cwd_sys_is_absolute
1113 XS_Cwd_sys_is_relative
1114 XS_Cwd_sys_is_rooted
1115 XS_DynaLoader_mod2fname
1116 XS_File__Copy_syscopy
1120 Perl_Process_Messages
1132 elsif ($ARGS{PLATFORM} eq 'netware') {
1259 fnInsertHashListAddrs
1271 # When added this code was only run for Win32 and WinCE
1272 # Currently only Win32 links static extensions into the shared library.
1273 # The WinCE makefile doesn't appear to support static extensions, so this code
1274 # can't have any effect there.
1275 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1276 # list of dynamic extensions, and the rules to build them)
1277 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1278 # static extensions with -fPIC, but links them to perl, not libperl.so
1279 # The VMS build scripts don't yet implement static extensions at all.
1281 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1282 # records of type boot_module for statically linked modules (except Dynaloader)
1283 my $static_ext = $Config{static_ext} // "";
1284 $static_ext =~ s/\//__/g;
1285 $static_ext =~ s/\bDynaLoader\b//;
1286 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1287 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1290 if ($ARGS{PLATFORM} eq 'os2') {
1291 my (%mapped, @missing);
1292 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1293 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1294 close MAP or die 'Cannot close miniperl.map';
1296 @missing = grep { !exists $mapped{$_} }
1298 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1299 delete $export{$_} foreach @missing;
1302 ###############################################################################
1304 # Now all symbols should be defined because next we are going to output them.
1306 # Start with platform specific headers:
1308 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1309 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1310 : "perl$Config{api_revision}$Config{api_version}";
1311 print "LIBRARY $dll\n";
1312 # The DESCRIPTION module definition file statement is not supported
1314 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1315 print "DESCRIPTION 'Perl interpreter'\n";
1319 elsif ($ARGS{PLATFORM} eq 'os2') {
1320 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1321 $v .= '-thread' if $Config{archname} =~ /-thread/;
1322 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1323 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1324 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1325 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1326 print <<"---EOP---";
1327 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1331 DATA LOADONCALL NONSHARED MULTIPLE
1335 elsif ($ARGS{PLATFORM} eq 'aix') {
1336 my $OSVER = `uname -v`;
1338 my $OSREL = `uname -r`;
1340 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1346 elsif ($ARGS{PLATFORM} eq 'netware') {
1347 if ($ARGS{FILETYPE} eq 'def') {
1348 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1349 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1356 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1357 foreach my $symbol (@symbols) {
1358 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1359 print "\t$symbol\n";
1361 elsif ($ARGS{PLATFORM} eq 'os2') {
1362 printf qq( %-31s \@%s\n),
1363 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1364 printf qq( %-31s \@%s\n),
1365 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1366 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1367 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1369 elsif ($ARGS{PLATFORM} eq 'netware') {
1370 print "\t$symbol,\n";
1376 # Then platform specific footers.
1378 if ($ARGS{PLATFORM} eq 'os2') {
1383 Perl_OS2_handler_install
1385 ; LAST_ORDINAL=$sym_ord