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{USE_ITHREADS} && ! $define{NO_LOCALE_THREADS}) {
144 $define{USE_LOCALE_THREADS} = 1;
146 if (! $define{HAS_SETLOCALE} && $define{HAS_POSIX_2008_LOCALE}) {
147 $define{USE_POSIX_2008_LOCALE} = 1;
148 $define{USE_THREAD_SAFE_LOCALE} = 1;
150 elsif ( ($define{USE_LOCALE_THREADS} || $define{USE_THREAD_SAFE_LOCALE})
151 && ( $define{HAS_POSIX_2008_LOCALE}
152 || ($ARGS{PLATFORM} eq 'win32' && ( $cctype !~ /\D/
154 && ! $define{NO_THREAD_SAFE_LOCALE})
156 $define{USE_THREAD_SAFE_LOCALE} = 1 unless $define{USE_THREAD_SAFE_LOCALE};
157 $define{USE_POSIX_2008_LOCALE} = 1 if $define{HAS_POSIX_2008_LOCALE};
160 if ( ($define{USE_POSIX_2008_LOCALE} && ! $define{HAS_QUERYLOCALE}))
162 $define{USE_PL_CURLOCALES} = 1;
165 if ( $ARGS{PLATFORM} eq 'win32'
166 && $define{USE_THREAD_SAFE_LOCALE}
169 $define{TS_W32_BROKEN_LOCALECONV} = 1;
172 # perl.h logic duplication ends
174 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
175 unless $ARGS{PLATFORM} eq 'test';
180 if ($ARGS{PLATFORM} eq 'os2') {
181 if (open my $fh, '<', 'perl5.def') {
183 last if /^\s*EXPORTS\b/;
186 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
187 # This allows skipping ordinals which were used in older versions
188 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
190 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
195 # All platforms export boot_DynaLoader unconditionally.
196 my %export = ( boot_DynaLoader => 1 );
198 # d_thread_local not perl_thread_local - see hints/darwin.sh
199 ++$export{PL_current_context}
200 if defined $Config{d_thread_local} && $define{USE_ITHREADS};
203 foreach my $symbol (@_) {
204 ++$export{$symbol} unless exists $skip{$symbol};
209 # $hash is the hash that we're adding to. For one of our callers, it will
210 # actually be the skip hash but that doesn't affect the intent of what
211 # we're doing, as in that case we skip adding something to the skip hash
212 # for the second time.
214 my $file = $ARGS{TARG_DIR} . shift;
217 open my $vars, '<', $file or die "Cannot open $file: $!\n";
220 # All symbols have a Perl_ prefix because that's what embed.h sticks
221 # in front of them. The A?I?S?C? is strictly speaking wrong.
222 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
225 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
226 ++$hash->{$symbol} unless exists $skip{$var};
230 if ($ARGS{PLATFORM} ne 'os2') {
231 ++$skip{$_} foreach qw(
243 if ($ARGS{PLATFORM} eq 'vms') {
244 ++$skip{PL_statusvalue_posix};
245 # This is a wrapper if we have symlink, not a replacement
247 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
249 ++$skip{PL_statusvalue_vms};
250 ++$skip{PL_perllib_sep};
251 if ($ARGS{PLATFORM} ne 'aix') {
252 ++$skip{$_} foreach qw(
263 if ($ARGS{PLATFORM} ne 'vms') {
264 # VMS does its own thing for these symbols.
265 ++$skip{$_} foreach qw(
266 PL_sig_handlers_initted
270 if ($ARGS{PLATFORM} ne 'win32') {
271 ++$skip{$_} foreach qw(
279 if ($ARGS{PLATFORM} ne 'win32') {
280 ++$skip{$_} foreach qw(
281 Perl_get_win32_message_utf8ness
282 Perl_Win_utf8_string_to_wstring
283 Perl_Win_wstring_to_utf8_string
287 unless ($define{UNLINK_ALL_VERSIONS}) {
291 unless ($define{'DEBUGGING'}) {
292 ++$skip{$_} foreach qw(
306 if ($define{'PERL_IMPLICIT_SYS'}) {
307 ++$skip{$_} foreach qw(
311 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
312 ++$export{perl_clone_host} if $define{USE_ITHREADS};
315 ++$skip{$_} foreach qw(
330 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
331 ++$skip{Perl_sv_setsv_cow};
334 unless ($define{PERL_SAWAMPERSAND}) {
335 ++$skip{PL_sawampersand};
338 unless ($define{'USE_REENTRANT_API'}) {
339 ++$skip{PL_reentrant_buffer};
342 if ($define{'MYMALLOC'}) {
351 unless ($define{USE_ITHREADS}) {
352 ++$skip{PL_malloc_mutex}
356 ++$skip{$_} foreach qw(
365 unless ($define{'USE_ITHREADS'}) {
367 ++$skip{PL_user_prop_mutex};
368 ++$skip{PL_user_def_props_aTHX};
371 unless ($define{'USE_ITHREADS'}) {
372 ++$skip{$_} foreach qw(
373 PL_keyword_plugin_mutex
382 PL_locale_mutex_depth
390 Perl_clone_params_del
391 Perl_clone_params_new
410 Perl_stashpv_hvname_match
411 Perl_regdupe_internal
416 unless ($define{USE_POSIX_2008_LOCALE})
418 ++$skip{$_} foreach qw(
420 PL_scratch_locale_obj
421 PL_underlying_numeric_obj
424 unless ($define{USE_PL_CURLOCALES})
426 ++$skip{$_} foreach qw(
431 unless ($define{'MULTIPLICITY'}) {
432 ++$skip{$_} foreach qw(
442 Perl_load_module_nocontext
445 Perl_warner_nocontext
446 Perl_newSVpvf_nocontext
447 Perl_sv_catpvf_nocontext
448 Perl_sv_setpvf_nocontext
449 Perl_sv_catpvf_mg_nocontext
450 Perl_sv_setpvf_mg_nocontext
456 unless ($define{'USE_DTRACE'}) {
457 ++$skip{$_} foreach qw(
458 Perl_dtrace_probe_call
459 Perl_dtrace_probe_load
461 Perl_dtrace_probe_phase
465 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
466 ++$skip{PL_sv_serial};
469 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
470 ++$skip{PL_dumper_fd};
473 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
474 ++$skip{Perl_gv_SVadd};
477 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
478 ++$skip{PL_pidstatus};
481 unless ($define{'PERL_TRACK_MEMPOOL'}) {
482 ++$skip{PL_memory_debug_header};
485 unless ($define{'PERL_MEM_LOG'}) {
486 ++$skip{$_} foreach qw(
496 unless ($define{'MULTIPLICITY'}) {
497 ++$skip{$_} foreach qw(
499 PL_interp_size_5_18_0
507 unless ($define{HAS_MMAP}) {
508 ++$skip{PL_mmap_page_size};
511 if ($define{HAS_SIGACTION}) {
512 ++$skip{PL_sig_trapped};
514 if ($ARGS{PLATFORM} eq 'vms') {
515 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
516 ++$skip{PL_sig_ignoring};
517 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
521 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
522 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
523 ++$skip{Perl_csighandler_init};
524 ++$skip{Perl_my_kill};
525 ++$skip{Perl_sig_to_vmscondition};
526 ++$skip{PL_sig_defaulting};
527 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
530 if ($define{'HAS_STRNLEN'})
532 ++$skip{Perl_my_strnlen};
535 unless ($define{USE_LOCALE_COLLATE}) {
536 ++$skip{$_} foreach qw(
539 PL_collation_standard
543 Perl_sv_collxfrm_flags
544 PL_strxfrm_NUL_replacement
545 PL_strxfrm_is_behaved
550 unless ($define{USE_LOCALE_NUMERIC}) {
551 ++$skip{$_} foreach qw(
552 PL_underlying_numeric_obj
556 unless ($define{USE_LOCALE_CTYPE}) {
557 ++$skip{$_} foreach qw(
562 unless ($define{'USE_C_BACKTRACE'}) {
563 ++$skip{Perl_get_c_backtrace_dump};
564 ++$skip{Perl_dump_c_backtrace};
567 unless ($define{HAVE_INTERP_INTERN}) {
568 ++$skip{$_} foreach qw(
569 Perl_sys_intern_clear
576 if ($define{HAS_SIGNBIT}) {
577 ++$skip{Perl_signbit};
580 ++$skip{PL_op_exec_cnt}
581 unless $define{PERL_TRACE_OPS};
583 ++$skip{PL_hash_chars}
584 unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
586 # functions from *.sym files
588 my @syms = qw(globvar.sym);
590 # Symbols that are the public face of the PerlIO layers implementation
591 # These are in _addition to_ the public face of the abstraction
592 # and need to be exported to allow XS modules to implement layers
607 PerlIOBase_setlinebuf
646 Perl_PerlIO_context_layers
653 Perl_PerlIO_get_bufsiz
657 Perl_PerlIO_restore_errno
658 Perl_PerlIO_save_errno
661 Perl_PerlIO_set_ptrcnt
662 Perl_PerlIO_setlinebuf
671 # Export the symbols that make up the PerlIO abstraction, regardless
672 # of its implementation - read from a file
673 push @syms, 'perlio.sym';
675 # PerlIO with layers - export implementation
676 try_symbols(@layer_syms, 'perlsio_binmode');
679 unless ($define{'USE_QUADMATH'}) {
680 ++$skip{Perl_quadmath_format_needed};
681 ++$skip{Perl_quadmath_format_single};
684 unless ($Config{d_mbrlen}) {
685 ++$skip{PL_mbrlen_ps};
688 unless ($Config{d_mbrtowc}) {
689 ++$skip{PL_mbrtowc_ps};
692 unless ($Config{d_wcrtomb}) {
693 ++$skip{PL_wcrtomb_ps};
696 ###############################################################################
698 # At this point all skip lists should be completed, as we are about to test
699 # many symbols against them.
703 my ($embed) = setup_embed($ARGS{TARG_DIR});
704 my $excludedre = $define{'NO_MATHOMS'} ? qr/[emiIsb]/ : qr/[emiIs]/;
707 my ($flags, $retval, $func, @args) = @$_;
709 if (($flags =~ /[AXC]/ && $flags !~ $excludedre)
710 || (!$define{'NO_MATHOMS'} && $flags =~ /b/))
712 # public API, so export
714 # If a function is defined twice, for example before and after
715 # an #else, only export its name once. Important to do this test
716 # within the block, as the *first* definition may have flags which
717 # mean "don't export"
718 next if $seen{$func}++;
719 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
720 $func = "Perl_$func" if ($flags =~ /[psX]/ && $func !~ /^Perl_/);
721 ++$export{$func} unless exists $skip{$func};
727 my $syms = $ARGS{TARG_DIR} . $_;
728 open my $global, '<', $syms or die "failed to open $syms: $!\n";
730 next unless /^([A-Za-z].*)/;
732 ++$export{$symbol} unless exists $skip{$symbol};
738 readvar('perlvars.h', \%export);
739 unless ($define{MULTIPLICITY}) {
740 readvar('intrpvar.h', \%export);
743 # Oddities from PerlIO
744 # All have alternate implementations in perlio.c, so always exist.
745 # Should they be considered to be part of the API?
754 if ($ARGS{PLATFORM} eq 'win32') {
819 win32_getprotobynumber
919 elsif ($ARGS{PLATFORM} eq 'vms') {
924 Perl_csighandler_init
927 Perl_fileify_dirspec_ts
928 Perl_fileify_dirspec_utf8
929 Perl_fileify_dirspec_utf8_ts
962 Perl_pathify_dirspec_ts
963 Perl_pathify_dirspec_utf8
964 Perl_pathify_dirspec_utf8_ts
972 Perl_rmsexpand_utf8_ts
974 Perl_sig_to_vmscondition
979 Perl_tounixpath_utf8_ts
983 Perl_tounixspec_utf8_ts
987 Perl_tovmspath_utf8_ts
991 Perl_tovmsspec_utf8_ts
993 Perl_vms_case_tolerant
1004 elsif ($ARGS{PLATFORM} eq 'os2') {
1047 XS_Cwd_current_drive
1049 XS_Cwd_extLibpath_set
1053 XS_Cwd_sys_is_absolute
1054 XS_Cwd_sys_is_relative
1055 XS_Cwd_sys_is_rooted
1056 XS_DynaLoader_mod2fname
1057 XS_File__Copy_syscopy
1061 Perl_Process_Messages
1074 # When added this code was only run for Win32 (and WinCE at the time)
1075 # Currently only Win32 links static extensions into the shared library.
1076 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1077 # static extensions with -fPIC, but links them to perl, not libperl.so
1078 # The VMS build scripts don't yet implement static extensions at all.
1080 if ($ARGS{PLATFORM} eq 'win32') {
1081 # records of type boot_module for statically linked modules (except Dynaloader)
1082 my $static_ext = $Config{static_ext} // "";
1083 $static_ext =~ s/\//__/g;
1084 $static_ext =~ s/\bDynaLoader\b//;
1085 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1086 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1089 if ($ARGS{PLATFORM} eq 'os2') {
1090 my (%mapped, @missing);
1091 open MAP, '<', 'miniperl.map' or die 'Cannot read miniperl.map';
1092 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1093 close MAP or die 'Cannot close miniperl.map';
1095 @missing = grep { !exists $mapped{$_} }
1097 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1098 delete $export{$_} foreach @missing;
1101 ###############################################################################
1103 # Now all symbols should be defined because next we are going to output them.
1105 # Start with platform specific headers:
1107 if ($ARGS{PLATFORM} eq 'win32') {
1108 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1109 : "perl$Config{api_revision}$Config{api_version}";
1110 print "LIBRARY $dll\n";
1111 # The DESCRIPTION module definition file statement is not supported
1113 if ($ARGS{CCTYPE} eq 'GCC') {
1114 print "DESCRIPTION 'Perl interpreter'\n";
1118 elsif ($ARGS{PLATFORM} eq 'os2') {
1119 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1120 $v .= '-thread' if $Config{archname} =~ /-thread/;
1121 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1122 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1123 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1124 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1125 print <<"---EOP---";
1126 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1130 DATA LOADONCALL NONSHARED MULTIPLE
1134 elsif ($ARGS{PLATFORM} eq 'aix') {
1135 my $OSVER = `uname -v`;
1137 my $OSREL = `uname -r`;
1139 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1148 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1149 foreach my $symbol (@symbols) {
1150 if (PLATFORM eq 'win32') {
1151 # Remembering the origin file of each symbol is an alternative to PL_ matching
1152 if (substr($symbol, 0, 3) eq 'PL_') {
1153 print "\t$symbol DATA\n";
1156 print "\t$symbol\n";
1159 elsif (PLATFORM eq 'os2') {
1160 printf qq( %-31s \@%s\n),
1161 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1162 printf qq( %-31s \@%s\n),
1163 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1164 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1165 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1171 # Then platform specific footers.
1173 if ($ARGS{PLATFORM} eq 'os2') {
1178 Perl_OS2_handler_install
1180 ; LAST_ORDINAL=$sym_ord