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:
42 %ARGS = (CCTYPE => 'MSVC', TARG_DIR => '');
44 sub process_cc_flags {
45 foreach (map {split /\s+/, $_} @_) {
46 $define{$1} = $2 // 1 if /^-D(\w+)(?:=(.+))?/;
52 if ($flag =~ /^(?:CC_FLAGS=)?(-D\w.*)/) {
54 } elsif ($flag =~ /^(CCTYPE|FILETYPE|PLATFORM|TARG_DIR)=(.+)$/) {
56 } elsif ($flag eq '--sort-fold') {
60 my @PLATFORM = qw(aix win32 os2 vms test);
62 @PLATFORM{@PLATFORM} = ();
64 die "PLATFORM undefined, must be one of: @PLATFORM\n"
65 unless defined $ARGS{PLATFORM};
66 die "PLATFORM must be one of: @PLATFORM\n"
67 unless exists $PLATFORM{$ARGS{PLATFORM}};
69 use constant PLATFORM => $ARGS{PLATFORM};
71 require "./$ARGS{TARG_DIR}regen/embed_lib.pl";
73 # Is the following guard strictly necessary? Added during refactoring
74 # to keep the same behaviour when merging other code into here.
75 process_cc_flags(@Config{qw(ccflags optimize)})
76 if $ARGS{PLATFORM} ne 'win32';
78 # Add the compile-time options that miniperl was built with to %define.
79 # On Win32 these are not the same options as perl itself will be built
80 # with since miniperl is built with a canned config (one of the win32/
81 # config_H.*) and none of the BUILDOPT's that are set in the makefiles,
82 # but they do include some #define's that are hard-coded in various
83 # source files and header files and don't include any BUILDOPT's that
84 # the user might have chosen to disable because the canned configs are
85 # minimal configs that don't include any of those options.
87 my @options = sort(Config::bincompat_options(), Config::non_bincompat_options());
88 print STDERR "Options: (@options)\n" unless $ARGS{PLATFORM} eq 'test';
89 $define{$_} = 1 foreach @options;
91 my %exportperlmalloc =
93 Perl_malloc => "malloc",
95 Perl_realloc => "realloc",
96 Perl_calloc => "calloc",
99 my $exportperlmalloc = $ARGS{PLATFORM} eq 'os2';
101 my $config_h = 'config.h';
102 open(CFG, '<', $config_h) || die "Cannot open $config_h: $!\n";
104 $define{$1} = 1 if /^\s*\#\s*define\s+(MYMALLOC|MULTIPLICITY
106 |(?:PERL|USE|HAS)_\w+)\b/x;
110 # perl.h logic duplication begins
112 if ($define{USE_ITHREADS}) {
113 if (!$define{MULTIPLICITY}) {
114 $define{MULTIPLICITY} = 1;
118 $define{MULTIPLICITY} ||=
119 $define{USE_ITHREADS} ||
120 $define{PERL_IMPLICIT_CONTEXT} ;
122 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32') {
123 $define{USE_REENTRANT_API} = 1;
126 if (! $define{NO_LOCALE}) {
127 if ( ! $define{NO_POSIX_2008_LOCALE}
128 && $define{HAS_NEWLOCALE}
129 && $define{HAS_USELOCALE}
130 && $define{HAS_DUPLOCALE}
131 && $define{HAS_FREELOCALE})
133 $define{HAS_POSIX_2008_LOCALE} = 1;
134 $define{USE_LOCALE} = 1;
136 elsif ($define{HAS_SETLOCALE}) {
137 $define{USE_LOCALE} = 1;
141 # https://en.wikipedia.org/wiki/Microsoft_Visual_C%2B%2B#Internal_version_numbering
142 my $cctype = $ARGS{CCTYPE} =~ s/MSVC//r;
143 if (! $define{HAS_SETLOCALE} && $define{HAS_POSIX_2008_LOCALE}) {
144 $define{USE_POSIX_2008_LOCALE} = 1;
145 $define{USE_THREAD_SAFE_LOCALE} = 1;
147 elsif ( ($define{USE_ITHREADS} || $define{USE_THREAD_SAFE_LOCALE})
148 && ( $define{HAS_POSIX_2008_LOCALE}
149 || ($ARGS{PLATFORM} eq 'win32' && ( $cctype !~ /\D/
151 && ! $define{NO_THREAD_SAFE_LOCALE})
153 $define{USE_THREAD_SAFE_LOCALE} = 1 unless $define{USE_THREAD_SAFE_LOCALE};
154 $define{USE_POSIX_2008_LOCALE} = 1 if $define{HAS_POSIX_2008_LOCALE};
157 if ( $ARGS{PLATFORM} eq 'win32'
158 && $define{USE_THREAD_SAFE_LOCALE}
161 $define{TS_W32_BROKEN_LOCALECONV} = 1;
164 # perl.h logic duplication ends
166 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
167 unless $ARGS{PLATFORM} eq 'test';
172 if ($ARGS{PLATFORM} eq 'os2') {
173 if (open my $fh, '<', 'perl5.def') {
175 last if /^\s*EXPORTS\b/;
178 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
179 # This allows skipping ordinals which were used in older versions
180 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
182 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
187 # All platforms export boot_DynaLoader unconditionally.
188 my %export = ( boot_DynaLoader => 1 );
190 # d_thread_local not perl_thread_local - see hints/darwin.sh
191 ++$export{PL_current_context}
192 if defined $Config{d_thread_local} && $define{USE_ITHREADS};
195 foreach my $symbol (@_) {
196 ++$export{$symbol} unless exists $skip{$symbol};
201 # $hash is the hash that we're adding to. For one of our callers, it will
202 # actually be the skip hash but that doesn't affect the intent of what
203 # we're doing, as in that case we skip adding something to the skip hash
204 # for the second time.
206 my $file = $ARGS{TARG_DIR} . shift;
209 open my $vars, '<', $file or die "Cannot open $file: $!\n";
212 # All symbols have a Perl_ prefix because that's what embed.h sticks
213 # in front of them. The A?I?S?C? is strictly speaking wrong.
214 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
217 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
218 ++$hash->{$symbol} unless exists $skip{$var};
222 if ($ARGS{PLATFORM} ne 'os2') {
223 ++$skip{$_} foreach qw(
235 if ($ARGS{PLATFORM} eq 'vms') {
236 ++$skip{PL_statusvalue_posix};
237 # This is a wrapper if we have symlink, not a replacement
239 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
241 ++$skip{PL_statusvalue_vms};
242 ++$skip{PL_perllib_sep};
243 if ($ARGS{PLATFORM} ne 'aix') {
244 ++$skip{$_} foreach qw(
255 if ($ARGS{PLATFORM} ne 'vms') {
256 # VMS does its own thing for these symbols.
257 ++$skip{$_} foreach qw(
258 PL_sig_handlers_initted
262 if ($ARGS{PLATFORM} ne 'win32') {
263 ++$skip{$_} foreach qw(
271 if ($ARGS{PLATFORM} ne 'win32') {
272 ++$skip{$_} foreach qw(
277 unless ($define{UNLINK_ALL_VERSIONS}) {
281 unless ($define{'DEBUGGING'}) {
282 ++$skip{$_} foreach qw(
289 Perl__setlocale_debug_string
297 if ($define{'PERL_IMPLICIT_SYS'}) {
298 ++$skip{$_} foreach qw(
302 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
303 ++$export{perl_clone_host} if $define{USE_ITHREADS};
306 ++$skip{$_} foreach qw(
321 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
322 ++$skip{Perl_sv_setsv_cow};
325 unless ($define{PERL_SAWAMPERSAND}) {
326 ++$skip{PL_sawampersand};
329 unless ($define{'USE_REENTRANT_API'}) {
330 ++$skip{PL_reentrant_buffer};
333 if ($define{'MYMALLOC'}) {
342 unless ($define{USE_ITHREADS}) {
343 ++$skip{PL_malloc_mutex}
347 ++$skip{$_} foreach qw(
356 if ($define{'PERL_USE_SAFE_PUTENV'}) {
357 ++$skip{PL_use_safe_putenv};
360 unless ($define{'USE_ITHREADS'}) {
362 ++$skip{PL_user_prop_mutex};
363 ++$skip{PL_user_def_props_aTHX};
366 unless ($define{'USE_ITHREADS'}) {
367 ++$skip{$_} foreach qw(
368 PL_keyword_plugin_mutex
378 PL_lc_numeric_mutex_depth
386 Perl_clone_params_del
387 Perl_clone_params_new
406 Perl_stashpv_hvname_match
407 Perl_regdupe_internal
412 if ( $define{NO_LOCALE}
413 || (! $define{USE_ITHREADS} && ! $define{USE_THREAD_SAFE_LOCALE}))
415 ++$skip{$_} foreach qw(
421 unless ( $define{'HAS_NEWLOCALE'}
422 && $define{'HAS_FREELOCALE'}
423 && $define{'HAS_USELOCALE'}
424 && ! $define{'NO_POSIX_2008_LOCALE'})
426 ++$skip{$_} foreach qw(
428 PL_underlying_numeric_obj
432 unless ($define{'MULTIPLICITY'}) {
433 ++$skip{$_} foreach qw(
443 Perl_load_module_nocontext
446 Perl_warner_nocontext
447 Perl_newSVpvf_nocontext
448 Perl_sv_catpvf_nocontext
449 Perl_sv_setpvf_nocontext
450 Perl_sv_catpvf_mg_nocontext
451 Perl_sv_setpvf_mg_nocontext
457 if ($define{USE_THREAD_SAFE_LOCALE}) {
458 ++$skip{PL_lc_numeric_mutex};
459 ++$skip{PL_lc_numeric_mutex_depth};
462 unless ($define{'USE_DTRACE'}) {
463 ++$skip{$_} foreach qw(
464 Perl_dtrace_probe_call
465 Perl_dtrace_probe_load
467 Perl_dtrace_probe_phase
471 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
472 ++$skip{PL_sv_serial};
475 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
476 ++$skip{PL_dumper_fd};
479 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
480 ++$skip{Perl_gv_SVadd};
483 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
484 ++$skip{PL_pidstatus};
487 unless ($define{'PERL_TRACK_MEMPOOL'}) {
488 ++$skip{PL_memory_debug_header};
491 unless ($define{'PERL_MEM_LOG'}) {
495 unless ($define{'MULTIPLICITY'}) {
496 ++$skip{$_} foreach qw(
498 PL_interp_size_5_18_0
506 unless ($define{HAS_MMAP}) {
507 ++$skip{PL_mmap_page_size};
510 if ($define{HAS_SIGACTION}) {
511 ++$skip{PL_sig_trapped};
513 if ($ARGS{PLATFORM} eq 'vms') {
514 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
515 ++$skip{PL_sig_ignoring};
516 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
520 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
521 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
522 ++$skip{Perl_csighandler_init};
523 ++$skip{Perl_my_kill};
524 ++$skip{Perl_sig_to_vmscondition};
525 ++$skip{PL_sig_defaulting};
526 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
529 if ($define{'HAS_STRNLEN'})
531 ++$skip{Perl_my_strnlen};
534 unless ($define{USE_LOCALE_COLLATE}) {
535 ++$skip{$_} foreach qw(
538 PL_collation_standard
542 Perl_sv_collxfrm_flags
543 PL_strxfrm_NUL_replacement
544 PL_strxfrm_is_behaved
549 unless ($define{USE_LOCALE_NUMERIC}) {
550 ++$skip{$_} foreach qw(
555 PL_numeric_underlying
556 PL_numeric_underlying_is_standard
557 PL_underlying_numeric_obj
561 unless ($define{'USE_C_BACKTRACE'}) {
562 ++$skip{Perl_get_c_backtrace_dump};
563 ++$skip{Perl_dump_c_backtrace};
566 unless ($define{HAVE_INTERP_INTERN}) {
567 ++$skip{$_} foreach qw(
568 Perl_sys_intern_clear
575 if ($define{HAS_SIGNBIT}) {
576 ++$skip{Perl_signbit};
579 ++$skip{PL_op_exec_cnt}
580 unless $define{PERL_TRACE_OPS};
582 ++$skip{PL_hash_chars}
583 unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
585 # functions from *.sym files
587 my @syms = qw(globvar.sym);
589 # Symbols that are the public face of the PerlIO layers implementation
590 # These are in _addition to_ the public face of the abstraction
591 # and need to be exported to allow XS modules to implement layers
606 PerlIOBase_setlinebuf
645 Perl_PerlIO_context_layers
652 Perl_PerlIO_get_bufsiz
656 Perl_PerlIO_restore_errno
657 Perl_PerlIO_save_errno
660 Perl_PerlIO_set_ptrcnt
661 Perl_PerlIO_setlinebuf
670 # Export the symbols that make up the PerlIO abstraction, regardless
671 # of its implementation - read from a file
672 push @syms, 'perlio.sym';
674 # PerlIO with layers - export implementation
675 try_symbols(@layer_syms, 'perlsio_binmode');
678 unless ($define{'USE_QUADMATH'}) {
679 ++$skip{Perl_quadmath_format_needed};
680 ++$skip{Perl_quadmath_format_single};
683 unless ($Config{d_mbrlen}) {
684 ++$skip{PL_mbrlen_ps};
687 unless ($Config{d_mbrtowc}) {
688 ++$skip{PL_mbrtowc_ps};
691 unless ($Config{d_wcrtomb}) {
692 ++$skip{PL_wcrtomb_ps};
695 ###############################################################################
697 # At this point all skip lists should be completed, as we are about to test
698 # many symbols against them.
702 my ($embed) = setup_embed($ARGS{TARG_DIR});
703 my $excludedre = $define{'NO_MATHOMS'} ? qr/[emib]/ : qr/[emi]/;
706 my ($flags, $retval, $func, @args) = @$_;
708 if (($flags =~ /[AXC]/ && $flags !~ $excludedre)
709 || (!$define{'NO_MATHOMS'} && $flags =~ /b/))
711 # public API, so export
713 # If a function is defined twice, for example before and after
714 # an #else, only export its name once. Important to do this test
715 # within the block, as the *first* definition may have flags which
716 # mean "don't export"
717 next if $seen{$func}++;
718 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
719 $func = "Perl_$func" if ($flags =~ /[pX]/ && $func !~ /^Perl_/);
720 ++$export{$func} unless exists $skip{$func};
726 my $syms = $ARGS{TARG_DIR} . $_;
727 open my $global, '<', $syms or die "failed to open $syms: $!\n";
729 next unless /^([A-Za-z].*)/;
731 ++$export{$symbol} unless exists $skip{$symbol};
737 readvar('perlvars.h', \%export);
738 unless ($define{MULTIPLICITY}) {
739 readvar('intrpvar.h', \%export);
742 # Oddities from PerlIO
743 # All have alternate implementations in perlio.c, so always exist.
744 # Should they be considered to be part of the API?
753 if ($ARGS{PLATFORM} eq 'win32') {
818 win32_getprotobynumber
918 elsif ($ARGS{PLATFORM} eq 'vms') {
923 Perl_csighandler_init
926 Perl_fileify_dirspec_ts
927 Perl_fileify_dirspec_utf8
928 Perl_fileify_dirspec_utf8_ts
961 Perl_pathify_dirspec_ts
962 Perl_pathify_dirspec_utf8
963 Perl_pathify_dirspec_utf8_ts
971 Perl_rmsexpand_utf8_ts
973 Perl_sig_to_vmscondition
978 Perl_tounixpath_utf8_ts
982 Perl_tounixspec_utf8_ts
986 Perl_tovmspath_utf8_ts
990 Perl_tovmsspec_utf8_ts
992 Perl_vms_case_tolerant
1003 elsif ($ARGS{PLATFORM} eq 'os2') {
1046 XS_Cwd_current_drive
1048 XS_Cwd_extLibpath_set
1052 XS_Cwd_sys_is_absolute
1053 XS_Cwd_sys_is_relative
1054 XS_Cwd_sys_is_rooted
1055 XS_DynaLoader_mod2fname
1056 XS_File__Copy_syscopy
1060 Perl_Process_Messages
1073 # When added this code was only run for Win32 (and WinCE at the time)
1074 # Currently only Win32 links static extensions into the shared library.
1075 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1076 # static extensions with -fPIC, but links them to perl, not libperl.so
1077 # The VMS build scripts don't yet implement static extensions at all.
1079 if ($ARGS{PLATFORM} eq 'win32') {
1080 # records of type boot_module for statically linked modules (except Dynaloader)
1081 my $static_ext = $Config{static_ext} // "";
1082 $static_ext =~ s/\//__/g;
1083 $static_ext =~ s/\bDynaLoader\b//;
1084 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1085 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1088 if ($ARGS{PLATFORM} eq 'os2') {
1089 my (%mapped, @missing);
1090 open MAP, '<', 'miniperl.map' or die 'Cannot read miniperl.map';
1091 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1092 close MAP or die 'Cannot close miniperl.map';
1094 @missing = grep { !exists $mapped{$_} }
1096 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1097 delete $export{$_} foreach @missing;
1100 ###############################################################################
1102 # Now all symbols should be defined because next we are going to output them.
1104 # Start with platform specific headers:
1106 if ($ARGS{PLATFORM} eq 'win32') {
1107 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1108 : "perl$Config{api_revision}$Config{api_version}";
1109 print "LIBRARY $dll\n";
1110 # The DESCRIPTION module definition file statement is not supported
1112 if ($ARGS{CCTYPE} eq 'GCC') {
1113 print "DESCRIPTION 'Perl interpreter'\n";
1117 elsif ($ARGS{PLATFORM} eq 'os2') {
1118 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1119 $v .= '-thread' if $Config{archname} =~ /-thread/;
1120 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1121 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1122 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1123 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1124 print <<"---EOP---";
1125 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1129 DATA LOADONCALL NONSHARED MULTIPLE
1133 elsif ($ARGS{PLATFORM} eq 'aix') {
1134 my $OSVER = `uname -v`;
1136 my $OSREL = `uname -r`;
1138 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1147 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1148 foreach my $symbol (@symbols) {
1149 if (PLATFORM eq 'win32') {
1150 # Remembering the origin file of each symbol is an alternative to PL_ matching
1151 if (substr($symbol, 0, 3) eq 'PL_') {
1152 print "\t$symbol DATA\n";
1155 print "\t$symbol\n";
1158 elsif (PLATFORM eq 'os2') {
1159 printf qq( %-31s \@%s\n),
1160 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1161 printf qq( %-31s \@%s\n),
1162 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1163 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1164 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1170 # Then platform specific footers.
1172 if ($ARGS{PLATFORM} eq 'os2') {
1177 Perl_OS2_handler_install
1179 ; LAST_ORDINAL=$sym_ord