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 wince 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 '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 #don't use the host Perl's -V defines for the WinCE Perl
91 if($ARGS{PLATFORM} ne 'wince') {
92 my @options = sort(Config::bincompat_options(), Config::non_bincompat_options());
93 print STDERR "Options: (@options)\n" unless $ARGS{PLATFORM} eq 'test';
94 $define{$_} = 1 foreach @options;
97 my %exportperlmalloc =
99 Perl_malloc => "malloc",
100 Perl_mfree => "free",
101 Perl_realloc => "realloc",
102 Perl_calloc => "calloc",
105 my $exportperlmalloc = $ARGS{PLATFORM} eq 'os2';
107 my $config_h = 'config.h';
108 open(CFG, '<', $config_h) || die "Cannot open $config_h: $!\n";
110 $define{$1} = 1 if /^\s*\#\s*define\s+(MYMALLOC|MULTIPLICITY
112 |(?:PERL|USE|HAS)_\w+)\b/x;
116 # perl.h logic duplication begins
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 ++$skip{PL_perllib_sep};
209 if ($ARGS{PLATFORM} ne 'aix') {
210 ++$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 if ($ARGS{PLATFORM} ne 'win32') {
238 ++$skip{$_} foreach qw(
243 unless ($define{UNLINK_ALL_VERSIONS}) {
247 unless ($define{'DEBUGGING'}) {
248 ++$skip{$_} foreach qw(
255 Perl__setlocale_debug_string
264 if ($define{'PERL_IMPLICIT_SYS'}) {
265 ++$skip{$_} foreach qw(
269 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
270 ++$export{perl_clone_host} if $define{USE_ITHREADS};
273 ++$skip{$_} foreach qw(
288 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
289 ++$skip{Perl_sv_setsv_cow};
292 unless ($define{PERL_SAWAMPERSAND}) {
293 ++$skip{PL_sawampersand};
296 unless ($define{'USE_REENTRANT_API'}) {
297 ++$skip{PL_reentrant_buffer};
300 if ($define{'MYMALLOC'}) {
309 unless ($define{USE_ITHREADS}) {
310 ++$skip{PL_malloc_mutex}
314 ++$skip{$_} foreach qw(
323 if ($define{'PERL_USE_SAFE_PUTENV'}) {
324 ++$skip{PL_use_safe_putenv};
327 unless ($define{'USE_ITHREADS'}) {
331 # USE_5005THREADS symbols. Kept as reference for easier removal
332 ++$skip{$_} foreach qw(
350 Perl_new_struct_thread
351 Perl_per_thread_magicals
359 unless ($define{'USE_ITHREADS'}) {
360 ++$skip{$_} foreach qw(
361 PL_keyword_plugin_mutex
377 Perl_clone_params_del
378 Perl_clone_params_new
397 Perl_stashpv_hvname_match
398 Perl_regdupe_internal
403 unless ( $define{'HAS_NEWLOCALE'}
404 && $define{'HAS_FREELOCALE'}
405 && $define{'HAS_USELOCALE'}
406 && ! $define{'NO_POSIX_2008_LOCALE'})
408 ++$skip{$_} foreach qw(
410 PL_underlying_numeric_obj
414 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
415 ++$skip{$_} foreach qw(
424 Perl_load_module_nocontext
427 Perl_warner_nocontext
428 Perl_newSVpvf_nocontext
429 Perl_sv_catpvf_nocontext
430 Perl_sv_setpvf_nocontext
431 Perl_sv_catpvf_mg_nocontext
432 Perl_sv_setpvf_mg_nocontext
438 unless ($define{'PERL_OP_PARENT'}) {
439 ++$skip{$_} foreach qw(
444 unless ($define{'USE_DTRACE'}) {
445 ++$skip{$_} foreach qw(
446 Perl_dtrace_probe_call
447 Perl_dtrace_probe_load
449 Perl_dtrace_probe_phase
453 unless ($define{'PERL_NEED_APPCTX'}) {
457 unless ($define{'PERL_NEED_TIMESBASE'}) {
458 ++$skip{PL_timesbase};
461 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
462 ++$skip{PL_sv_serial};
465 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
466 ++$skip{PL_dumper_fd};
469 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
470 ++$skip{Perl_gv_SVadd};
473 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
474 ++$skip{PL_pidstatus};
477 unless ($define{'PERL_TRACK_MEMPOOL'}) {
478 ++$skip{PL_memory_debug_header};
481 unless ($define{'MULTIPLICITY'}) {
482 ++$skip{$_} foreach qw(
484 PL_interp_size_5_18_0
492 unless ($define{'PERL_GLOBAL_STRUCT'}) {
493 ++$skip{PL_global_struct_size};
496 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
497 ++$skip{$_} foreach qw(
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
543 unless ($define{USE_LOCALE_NUMERIC}) {
544 ++$skip{$_} foreach qw(
552 unless ($define{'USE_C_BACKTRACE'}) {
553 ++$skip{Perl_get_c_backtrace_dump};
554 ++$skip{Perl_dump_c_backtrace};
557 unless ($define{HAVE_INTERP_INTERN}) {
558 ++$skip{$_} foreach qw(
559 Perl_sys_intern_clear
566 if ($define{HAS_SIGNBIT}) {
567 ++$skip{Perl_signbit};
570 if ($define{'PERL_GLOBAL_STRUCT'}) {
571 readvar('perlvars.h', \%skip);
572 # This seems like the least ugly way to cope with the fact that PL_sh_path
573 # is mentioned in perlvar.h and globvar.sym, and always exported.
574 delete $skip{PL_sh_path};
575 ++$export{Perl_GetVars};
576 try_symbols(qw(PL_Vars PL_VarsPtr))
577 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
579 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
582 ++$skip{PL_op_exec_cnt}
583 unless $define{PERL_TRACE_OPS};
585 ++$skip{PL_hash_chars}
586 unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
588 # functions from *.sym files
590 my @syms = qw(globvar.sym);
592 # Symbols that are the public face of the PerlIO layers implementation
593 # These are in _addition to_ the public face of the abstraction
594 # and need to be exported to allow XS modules to implement layers
609 PerlIOBase_setlinebuf
648 Perl_PerlIO_context_layers
655 Perl_PerlIO_get_bufsiz
659 Perl_PerlIO_restore_errno
660 Perl_PerlIO_save_errno
663 Perl_PerlIO_set_ptrcnt
664 Perl_PerlIO_setlinebuf
672 if ($ARGS{PLATFORM} eq 'netware') {
673 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
676 # Export the symbols that make up the PerlIO abstraction, regardless
677 # of its implementation - read from a file
678 push @syms, 'perlio.sym';
680 # PerlIO with layers - export implementation
681 try_symbols(@layer_syms, 'perlsio_binmode');
684 unless ($define{'USE_QUADMATH'}) {
685 ++$skip{Perl_quadmath_format_needed};
686 ++$skip{Perl_quadmath_format_single};
689 ###############################################################################
691 # At this point all skip lists should be completed, as we are about to test
692 # many symbols against them.
696 my ($embed) = setup_embed($ARGS{TARG_DIR});
699 my ($flags, $retval, $func, @args) = @$_;
701 if ( ($flags =~ /[AX]/ && $flags !~ /[xmi]/)
702 || ($flags =~ /b/ && ! $define{'NO_MATHOMS'}))
704 # public API, so export
706 # If a function is defined twice, for example before and after
707 # an #else, only export its name once. Important to do this test
708 # within the block, as the *first* definition may have flags which
709 # mean "don't export"
710 next if $seen{$func}++;
711 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
712 $func = "Perl_$func" if ($flags =~ /[pX]/ && $func !~ /^Perl_/);
713 ++$export{$func} unless exists $skip{$func};
719 my $syms = $ARGS{TARG_DIR} . $_;
720 open my $global, '<', $syms or die "failed to open $syms: $!\n";
722 next unless /^([A-Za-z].*)/;
724 ++$export{$symbol} unless exists $skip{$symbol};
730 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
731 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
732 # XXX AIX seems to want the perlvars.h symbols, for some reason
733 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
734 readvar('perlvars.h', \%export);
738 unless ($define{'PERL_GLOBAL_STRUCT'}) {
739 readvar('perlvars.h', \%export);
741 unless ($define{MULTIPLICITY}) {
742 readvar('intrpvar.h', \%export);
746 # Oddities from PerlIO
747 # All have alternate implementations in perlio.c, so always exist.
748 # Should they be considered to be part of the API?
757 if ($ARGS{PLATFORM} eq 'win32') {
767 if ($ARGS{PLATFORM} eq 'wince') {
768 ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
771 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
832 win32_getprotobynumber
928 elsif ($ARGS{PLATFORM} eq 'vms') {
933 Perl_csighandler_init
936 Perl_fileify_dirspec_ts
937 Perl_fileify_dirspec_utf8
938 Perl_fileify_dirspec_utf8_ts
971 Perl_pathify_dirspec_ts
972 Perl_pathify_dirspec_utf8
973 Perl_pathify_dirspec_utf8_ts
981 Perl_rmsexpand_utf8_ts
983 Perl_sig_to_vmscondition
988 Perl_tounixpath_utf8_ts
992 Perl_tounixspec_utf8_ts
996 Perl_tovmspath_utf8_ts
1000 Perl_tovmsspec_utf8_ts
1002 Perl_vms_case_tolerant
1013 elsif ($ARGS{PLATFORM} eq 'os2') {
1056 XS_Cwd_current_drive
1058 XS_Cwd_extLibpath_set
1062 XS_Cwd_sys_is_absolute
1063 XS_Cwd_sys_is_relative
1064 XS_Cwd_sys_is_rooted
1065 XS_DynaLoader_mod2fname
1066 XS_File__Copy_syscopy
1070 Perl_Process_Messages
1082 elsif ($ARGS{PLATFORM} eq 'netware') {
1209 fnInsertHashListAddrs
1221 # When added this code was only run for Win32 and WinCE
1222 # Currently only Win32 links static extensions into the shared library.
1223 # The WinCE makefile doesn't appear to support static extensions, so this code
1224 # can't have any effect there.
1225 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1226 # list of dynamic extensions, and the rules to build them)
1227 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1228 # static extensions with -fPIC, but links them to perl, not libperl.so
1229 # The VMS build scripts don't yet implement static extensions at all.
1231 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1232 # records of type boot_module for statically linked modules (except Dynaloader)
1233 my $static_ext = $Config{static_ext} // "";
1234 $static_ext =~ s/\//__/g;
1235 $static_ext =~ s/\bDynaLoader\b//;
1236 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1237 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1240 if ($ARGS{PLATFORM} eq 'os2') {
1241 my (%mapped, @missing);
1242 open MAP, '<', 'miniperl.map' or die 'Cannot read miniperl.map';
1243 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1244 close MAP or die 'Cannot close miniperl.map';
1246 @missing = grep { !exists $mapped{$_} }
1248 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1249 delete $export{$_} foreach @missing;
1252 ###############################################################################
1254 # Now all symbols should be defined because next we are going to output them.
1256 # Start with platform specific headers:
1258 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1259 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1260 : "perl$Config{api_revision}$Config{api_version}";
1261 print "LIBRARY $dll\n";
1262 # The DESCRIPTION module definition file statement is not supported
1264 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1265 print "DESCRIPTION 'Perl interpreter'\n";
1269 elsif ($ARGS{PLATFORM} eq 'os2') {
1270 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1271 $v .= '-thread' if $Config{archname} =~ /-thread/;
1272 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1273 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1274 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1275 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1276 print <<"---EOP---";
1277 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1281 DATA LOADONCALL NONSHARED MULTIPLE
1285 elsif ($ARGS{PLATFORM} eq 'aix') {
1286 my $OSVER = `uname -v`;
1288 my $OSREL = `uname -r`;
1290 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1296 elsif ($ARGS{PLATFORM} eq 'netware') {
1297 if ($ARGS{FILETYPE} eq 'def') {
1298 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1299 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1306 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1307 foreach my $symbol (@symbols) {
1308 if (PLATFORM eq 'win32' || PLATFORM eq 'wince') {
1309 # Remembering the origin file of each symbol is an alternative to PL_ matching
1310 if (substr($symbol, 0, 3) eq 'PL_') {
1311 print "\t$symbol DATA\n";
1314 print "\t$symbol\n";
1317 elsif (PLATFORM eq 'os2') {
1318 printf qq( %-31s \@%s\n),
1319 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1320 printf qq( %-31s \@%s\n),
1321 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1322 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1323 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1325 elsif (PLATFORM eq 'netware') {
1326 print "\t$symbol,\n";
1332 # Then platform specific footers.
1334 if ($ARGS{PLATFORM} eq 'os2') {
1339 Perl_OS2_handler_install
1341 ; LAST_ORDINAL=$sym_ord