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:
40 BEGIN { unshift @INC, "lib" }
44 %ARGS = (CCTYPE => 'MSVC', TARG_DIR => '');
46 sub process_cc_flags {
47 foreach (map {split /\s+/, $_} @_) {
48 $define{$1} = $2 // 1 if /^-D(\w+)(?:=(.+))?/;
54 if ($flag =~ /^(?:CC_FLAGS=)?(-D\w.*)/) {
56 } elsif ($flag =~ /^(CCTYPE|FILETYPE|PLATFORM|TARG_DIR)=(.+)$/) {
58 } elsif ($flag eq '--sort-fold') {
62 my @PLATFORM = qw(aix win32 os2 netware vms test);
64 @PLATFORM{@PLATFORM} = ();
66 die "PLATFORM undefined, must be one of: @PLATFORM\n"
67 unless defined $ARGS{PLATFORM};
68 die "PLATFORM must be one of: @PLATFORM\n"
69 unless exists $PLATFORM{$ARGS{PLATFORM}};
71 use constant PLATFORM => $ARGS{PLATFORM};
73 require "./$ARGS{TARG_DIR}regen/embed_lib.pl";
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 'netware';
80 # Add the compile-time options that miniperl was built with to %define.
81 # On Win32 these are not the same options as perl itself will be built
82 # with since miniperl is built with a canned config (one of the win32/
83 # config_H.*) and none of the BUILDOPT's that are set in the makefiles,
84 # but they do include some #define's that are hard-coded in various
85 # source files and header files and don't include any BUILDOPT's that
86 # the user might have chosen to disable because the canned configs are
87 # minimal configs that don't include any of those options.
89 my @options = sort(Config::bincompat_options(), Config::non_bincompat_options());
90 print STDERR "Options: (@options)\n" unless $ARGS{PLATFORM} eq 'test';
91 $define{$_} = 1 foreach @options;
93 my %exportperlmalloc =
95 Perl_malloc => "malloc",
97 Perl_realloc => "realloc",
98 Perl_calloc => "calloc",
101 my $exportperlmalloc = $ARGS{PLATFORM} eq 'os2';
103 my $config_h = 'config.h';
104 open(CFG, '<', $config_h) || die "Cannot open $config_h: $!\n";
106 $define{$1} = 1 if /^\s*\#\s*define\s+(MYMALLOC|MULTIPLICITY
108 |(?:PERL|USE|HAS)_\w+)\b/x;
112 # perl.h logic duplication begins
114 if ($define{USE_ITHREADS}) {
115 if (!$define{MULTIPLICITY}) {
116 $define{MULTIPLICITY} = 1;
120 $define{PERL_IMPLICIT_CONTEXT} ||=
121 $define{USE_ITHREADS} ||
122 $define{MULTIPLICITY} ;
124 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $ARGS{PLATFORM} ne 'netware') {
125 $define{USE_REENTRANT_API} = 1;
128 if (! $define{NO_LOCALE}) {
129 if ( ! $define{NO_POSIX_2008_LOCALE}
130 && $define{HAS_NEWLOCALE}
131 && $define{HAS_USELOCALE}
132 && $define{HAS_DUPLOCALE}
133 && $define{HAS_FREELOCALE})
135 $define{HAS_POSIX_2008_LOCALE} = 1;
136 $define{USE_LOCALE} = 1;
138 elsif ($define{HAS_SETLOCALE}) {
139 $define{USE_LOCALE} = 1;
143 # https://en.wikipedia.org/wiki/Microsoft_Visual_C%2B%2B#Internal_version_numbering
144 my $cctype = $ARGS{CCTYPE} =~ s/MSVC//r;
145 if (! $define{HAS_SETLOCALE} && $define{HAS_POSIX_2008_LOCALE}) {
146 $define{USE_POSIX_2008_LOCALE} = 1;
147 $define{USE_THREAD_SAFE_LOCALE} = 1;
149 elsif ( ($define{USE_ITHREADS} || $define{USE_THREAD_SAFE_LOCALE})
150 && ( $define{HAS_POSIX_2008_LOCALE}
151 || ($ARGS{PLATFORM} eq 'win32' && ( $cctype !~ /\D/
153 && ! $define{NO_THREAD_SAFE_LOCALE})
155 $define{USE_THREAD_SAFE_LOCALE} = 1 unless $define{USE_THREAD_SAFE_LOCALE};
156 $define{USE_POSIX_2008_LOCALE} = 1 if $define{HAS_POSIX_2008_LOCALE};
159 if ( $ARGS{PLATFORM} eq 'win32'
160 && $define{USE_THREAD_SAFE_LOCALE}
163 $define{TS_W32_BROKEN_LOCALECONV} = 1;
166 # perl.h logic duplication ends
168 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
169 unless $ARGS{PLATFORM} eq 'test';
174 if ($ARGS{PLATFORM} eq 'os2') {
175 if (open my $fh, '<', 'perl5.def') {
177 last if /^\s*EXPORTS\b/;
180 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
181 # This allows skipping ordinals which were used in older versions
182 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
184 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
189 # All platforms export boot_DynaLoader unconditionally.
190 my %export = ( boot_DynaLoader => 1 );
193 foreach my $symbol (@_) {
194 ++$export{$symbol} unless exists $skip{$symbol};
199 # $hash is the hash that we're adding to. For one of our callers, it will
200 # actually be the skip hash but that doesn't affect the intent of what
201 # we're doing, as in that case we skip adding something to the skip hash
202 # for the second time.
204 my $file = $ARGS{TARG_DIR} . shift;
207 open my $vars, '<', $file or die "Cannot open $file: $!\n";
210 # All symbols have a Perl_ prefix because that's what embed.h sticks
211 # in front of them. The A?I?S?C? is strictly speaking wrong.
212 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
215 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
216 ++$hash->{$symbol} unless exists $skip{$var};
220 if ($ARGS{PLATFORM} ne 'os2') {
221 ++$skip{$_} foreach qw(
233 if ($ARGS{PLATFORM} eq 'vms') {
234 ++$skip{PL_statusvalue_posix};
235 # This is a wrapper if we have symlink, not a replacement
237 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
239 ++$skip{PL_statusvalue_vms};
240 ++$skip{PL_perllib_sep};
241 if ($ARGS{PLATFORM} ne 'aix') {
242 ++$skip{$_} foreach qw(
253 if ($ARGS{PLATFORM} ne 'vms') {
254 # VMS does its own thing for these symbols.
255 ++$skip{$_} foreach qw(
256 PL_sig_handlers_initted
260 if ($ARGS{PLATFORM} ne 'win32') {
261 ++$skip{$_} foreach qw(
269 if ($ARGS{PLATFORM} ne 'win32') {
270 ++$skip{$_} foreach qw(
275 unless ($define{UNLINK_ALL_VERSIONS}) {
279 unless ($define{'DEBUGGING'}) {
280 ++$skip{$_} foreach qw(
287 Perl__setlocale_debug_string
295 if ($define{'PERL_IMPLICIT_SYS'}) {
296 ++$skip{$_} foreach qw(
300 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
301 ++$export{perl_clone_host} if $define{USE_ITHREADS};
304 ++$skip{$_} foreach qw(
319 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
320 ++$skip{Perl_sv_setsv_cow};
323 unless ($define{PERL_SAWAMPERSAND}) {
324 ++$skip{PL_sawampersand};
327 unless ($define{'USE_REENTRANT_API'}) {
328 ++$skip{PL_reentrant_buffer};
331 if ($define{'MYMALLOC'}) {
340 unless ($define{USE_ITHREADS}) {
341 ++$skip{PL_malloc_mutex}
345 ++$skip{$_} foreach qw(
354 if ($define{'PERL_USE_SAFE_PUTENV'}) {
355 ++$skip{PL_use_safe_putenv};
358 unless ($define{'USE_ITHREADS'}) {
360 ++$skip{PL_user_prop_mutex};
361 ++$skip{PL_user_def_props_aTHX};
364 unless ($define{'USE_ITHREADS'}) {
365 ++$skip{$_} foreach qw(
366 PL_keyword_plugin_mutex
376 PL_lc_numeric_mutex_depth
384 Perl_clone_params_del
385 Perl_clone_params_new
404 Perl_stashpv_hvname_match
405 Perl_regdupe_internal
410 if ( $define{NO_LOCALE}
411 || (! $define{USE_ITHREADS} && ! $define{USE_THREAD_SAFE_LOCALE}))
413 ++$skip{$_} foreach qw(
419 unless ( $define{'HAS_NEWLOCALE'}
420 && $define{'HAS_FREELOCALE'}
421 && $define{'HAS_USELOCALE'}
422 && ! $define{'NO_POSIX_2008_LOCALE'})
424 ++$skip{$_} foreach qw(
426 PL_underlying_numeric_obj
430 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
431 ++$skip{$_} foreach qw(
441 Perl_load_module_nocontext
444 Perl_warner_nocontext
445 Perl_newSVpvf_nocontext
446 Perl_sv_catpvf_nocontext
447 Perl_sv_setpvf_nocontext
448 Perl_sv_catpvf_mg_nocontext
449 Perl_sv_setpvf_mg_nocontext
455 if ($define{USE_THREAD_SAFE_LOCALE}) {
456 ++$skip{PL_lc_numeric_mutex};
457 ++$skip{PL_lc_numeric_mutex_depth};
458 if (! $define{TS_W32_BROKEN_LOCALECONV}) {
459 ++$skip{PL_locale_mutex};
463 unless ($define{'USE_DTRACE'}) {
464 ++$skip{$_} foreach qw(
465 Perl_dtrace_probe_call
466 Perl_dtrace_probe_load
468 Perl_dtrace_probe_phase
472 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
473 ++$skip{PL_sv_serial};
476 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
477 ++$skip{PL_dumper_fd};
480 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
481 ++$skip{Perl_gv_SVadd};
484 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
485 ++$skip{PL_pidstatus};
488 unless ($define{'PERL_TRACK_MEMPOOL'}) {
489 ++$skip{PL_memory_debug_header};
492 unless ($define{'MULTIPLICITY'}) {
493 ++$skip{$_} foreach qw(
495 PL_interp_size_5_18_0
503 unless ($define{HAS_MMAP}) {
504 ++$skip{PL_mmap_page_size};
507 if ($define{HAS_SIGACTION}) {
508 ++$skip{PL_sig_trapped};
510 if ($ARGS{PLATFORM} eq 'vms') {
511 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
512 ++$skip{PL_sig_ignoring};
513 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
517 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
518 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
519 ++$skip{Perl_csighandler_init};
520 ++$skip{Perl_my_kill};
521 ++$skip{Perl_sig_to_vmscondition};
522 ++$skip{PL_sig_defaulting};
523 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
526 if ($define{'HAS_STRNLEN'})
528 ++$skip{Perl_my_strnlen};
531 unless ($define{USE_LOCALE_COLLATE}) {
532 ++$skip{$_} foreach qw(
535 PL_collation_standard
539 Perl_sv_collxfrm_flags
540 PL_strxfrm_NUL_replacement
541 PL_strxfrm_is_behaved
546 unless ($define{USE_LOCALE_NUMERIC}) {
547 ++$skip{$_} foreach qw(
552 PL_numeric_underlying
553 PL_numeric_underlying_is_standard
554 PL_underlying_numeric_obj
558 unless ($define{'USE_C_BACKTRACE'}) {
559 ++$skip{Perl_get_c_backtrace_dump};
560 ++$skip{Perl_dump_c_backtrace};
563 unless ($define{HAVE_INTERP_INTERN}) {
564 ++$skip{$_} foreach qw(
565 Perl_sys_intern_clear
572 if ($define{HAS_SIGNBIT}) {
573 ++$skip{Perl_signbit};
576 ++$skip{PL_op_exec_cnt}
577 unless $define{PERL_TRACE_OPS};
579 ++$skip{PL_hash_chars}
580 unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
582 # functions from *.sym files
584 my @syms = qw(globvar.sym);
586 # Symbols that are the public face of the PerlIO layers implementation
587 # These are in _addition to_ the public face of the abstraction
588 # and need to be exported to allow XS modules to implement layers
603 PerlIOBase_setlinebuf
642 Perl_PerlIO_context_layers
649 Perl_PerlIO_get_bufsiz
653 Perl_PerlIO_restore_errno
654 Perl_PerlIO_save_errno
657 Perl_PerlIO_set_ptrcnt
658 Perl_PerlIO_setlinebuf
666 if ($ARGS{PLATFORM} eq 'netware') {
667 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
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
915 elsif ($ARGS{PLATFORM} eq 'vms') {
920 Perl_csighandler_init
923 Perl_fileify_dirspec_ts
924 Perl_fileify_dirspec_utf8
925 Perl_fileify_dirspec_utf8_ts
958 Perl_pathify_dirspec_ts
959 Perl_pathify_dirspec_utf8
960 Perl_pathify_dirspec_utf8_ts
968 Perl_rmsexpand_utf8_ts
970 Perl_sig_to_vmscondition
975 Perl_tounixpath_utf8_ts
979 Perl_tounixspec_utf8_ts
983 Perl_tovmspath_utf8_ts
987 Perl_tovmsspec_utf8_ts
989 Perl_vms_case_tolerant
1000 elsif ($ARGS{PLATFORM} eq 'os2') {
1043 XS_Cwd_current_drive
1045 XS_Cwd_extLibpath_set
1049 XS_Cwd_sys_is_absolute
1050 XS_Cwd_sys_is_relative
1051 XS_Cwd_sys_is_rooted
1052 XS_DynaLoader_mod2fname
1053 XS_File__Copy_syscopy
1057 Perl_Process_Messages
1069 elsif ($ARGS{PLATFORM} eq 'netware') {
1195 fnInsertHashListAddrs
1207 # When added this code was only run for Win32 (and WinCE at the time)
1208 # Currently only Win32 links static extensions into the shared library.
1209 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1210 # list of dynamic extensions, and the rules to build them)
1211 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1212 # static extensions with -fPIC, but links them to perl, not libperl.so
1213 # The VMS build scripts don't yet implement static extensions at all.
1215 if ($ARGS{PLATFORM} eq 'win32') {
1216 # records of type boot_module for statically linked modules (except Dynaloader)
1217 my $static_ext = $Config{static_ext} // "";
1218 $static_ext =~ s/\//__/g;
1219 $static_ext =~ s/\bDynaLoader\b//;
1220 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1221 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1224 if ($ARGS{PLATFORM} eq 'os2') {
1225 my (%mapped, @missing);
1226 open MAP, '<', 'miniperl.map' or die 'Cannot read miniperl.map';
1227 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1228 close MAP or die 'Cannot close miniperl.map';
1230 @missing = grep { !exists $mapped{$_} }
1232 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1233 delete $export{$_} foreach @missing;
1236 ###############################################################################
1238 # Now all symbols should be defined because next we are going to output them.
1240 # Start with platform specific headers:
1242 if ($ARGS{PLATFORM} eq 'win32') {
1243 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1244 : "perl$Config{api_revision}$Config{api_version}";
1245 print "LIBRARY $dll\n";
1246 # The DESCRIPTION module definition file statement is not supported
1248 if ($ARGS{CCTYPE} eq 'GCC') {
1249 print "DESCRIPTION 'Perl interpreter'\n";
1253 elsif ($ARGS{PLATFORM} eq 'os2') {
1254 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1255 $v .= '-thread' if $Config{archname} =~ /-thread/;
1256 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1257 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1258 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1259 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1260 print <<"---EOP---";
1261 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1265 DATA LOADONCALL NONSHARED MULTIPLE
1269 elsif ($ARGS{PLATFORM} eq 'aix') {
1270 my $OSVER = `uname -v`;
1272 my $OSREL = `uname -r`;
1274 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1280 elsif ($ARGS{PLATFORM} eq 'netware') {
1281 if ($ARGS{FILETYPE} eq 'def') {
1282 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1283 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1290 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1291 foreach my $symbol (@symbols) {
1292 if (PLATFORM eq 'win32') {
1293 # Remembering the origin file of each symbol is an alternative to PL_ matching
1294 if (substr($symbol, 0, 3) eq 'PL_') {
1295 print "\t$symbol DATA\n";
1298 print "\t$symbol\n";
1301 elsif (PLATFORM eq 'os2') {
1302 printf qq( %-31s \@%s\n),
1303 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1304 printf qq( %-31s \@%s\n),
1305 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1306 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1307 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1309 elsif (PLATFORM eq 'netware') {
1310 print "\t$symbol,\n";
1316 # Then platform specific footers.
1318 if ($ARGS{PLATFORM} eq 'os2') {
1323 Perl_OS2_handler_install
1325 ; LAST_ORDINAL=$sym_ord