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 my $cctype = $ARGS{CCTYPE} =~ s/MSVC//r;
144 if (! $define{HAS_SETLOCALE} && $define{HAS_POSIX_2008_LOCALE}) {
145 $define{USE_POSIX_2008_LOCALE} = 1;
146 $define{USE_THREAD_SAFE_LOCALE} = 1;
148 elsif ( ($define{USE_ITHREADS} || $define{USE_THREAD_SAFE_LOCALE})
149 && ( $define{HAS_POSIX_2008_LOCALE}
150 || ($ARGS{PLATFORM} eq 'win32' && ( $cctype !~ /\D/
152 && ! $define{NO_THREAD_SAFE_LOCALE})
154 $define{USE_THREAD_SAFE_LOCALE} = 1 unless $define{USE_THREAD_SAFE_LOCALE};
155 $define{USE_POSIX_2008_LOCALE} = 1 if $define{HAS_POSIX_2008_LOCALE};
158 if ( $ARGS{PLATFORM} eq 'win32'
159 && $define{USE_THREAD_SAFE_LOCALE}
162 $define{TS_W32_BROKEN_LOCALECONV} = 1;
165 # perl.h logic duplication ends
167 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
168 unless $ARGS{PLATFORM} eq 'test';
173 if ($ARGS{PLATFORM} eq 'os2') {
174 if (open my $fh, '<', 'perl5.def') {
176 last if /^\s*EXPORTS\b/;
179 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
180 # This allows skipping ordinals which were used in older versions
181 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
183 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
188 # All platforms export boot_DynaLoader unconditionally.
189 my %export = ( boot_DynaLoader => 1 );
192 foreach my $symbol (@_) {
193 ++$export{$symbol} unless exists $skip{$symbol};
198 # $hash is the hash that we're adding to. For one of our callers, it will
199 # actually be the skip hash but that doesn't affect the intent of what
200 # we're doing, as in that case we skip adding something to the skip hash
201 # for the second time.
203 my $file = $ARGS{TARG_DIR} . shift;
206 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
209 # All symbols have a Perl_ prefix because that's what embed.h sticks
210 # in front of them. The A?I?S?C? is strictly speaking wrong.
211 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
214 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
215 ++$hash->{$symbol} unless exists $skip{$var};
219 if ($ARGS{PLATFORM} ne 'os2') {
220 ++$skip{$_} foreach qw(
234 if ($ARGS{PLATFORM} eq 'vms') {
235 ++$skip{PL_statusvalue_posix};
236 # This is a wrapper if we have symlink, not a replacement
238 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
240 ++$skip{PL_statusvalue_vms};
241 ++$skip{PL_perllib_sep};
242 if ($ARGS{PLATFORM} ne 'aix') {
243 ++$skip{$_} foreach qw(
254 if ($ARGS{PLATFORM} ne 'vms') {
255 # VMS does its own thing for these symbols.
256 ++$skip{$_} foreach qw(
257 PL_sig_handlers_initted
261 if ($ARGS{PLATFORM} ne 'win32') {
262 ++$skip{$_} foreach qw(
270 if ($ARGS{PLATFORM} ne 'win32') {
271 ++$skip{$_} foreach qw(
276 unless ($define{UNLINK_ALL_VERSIONS}) {
280 unless ($define{'DEBUGGING'}) {
281 ++$skip{$_} foreach qw(
288 Perl__setlocale_debug_string
296 if ($define{'PERL_IMPLICIT_SYS'}) {
297 ++$skip{$_} foreach qw(
301 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
302 ++$export{perl_clone_host} if $define{USE_ITHREADS};
305 ++$skip{$_} foreach qw(
320 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
321 ++$skip{Perl_sv_setsv_cow};
324 unless ($define{PERL_SAWAMPERSAND}) {
325 ++$skip{PL_sawampersand};
328 unless ($define{'USE_REENTRANT_API'}) {
329 ++$skip{PL_reentrant_buffer};
332 if ($define{'MYMALLOC'}) {
341 unless ($define{USE_ITHREADS}) {
342 ++$skip{PL_malloc_mutex}
346 ++$skip{$_} foreach qw(
355 if ($define{'PERL_USE_SAFE_PUTENV'}) {
356 ++$skip{PL_use_safe_putenv};
359 unless ($define{'USE_ITHREADS'}) {
361 ++$skip{PL_user_prop_mutex};
362 ++$skip{PL_user_def_props_aTHX};
365 # USE_5005THREADS symbols. Kept as reference for easier removal
366 ++$skip{$_} foreach qw(
384 Perl_new_struct_thread
385 Perl_per_thread_magicals
393 unless ($define{'USE_ITHREADS'}) {
394 ++$skip{$_} foreach qw(
395 PL_keyword_plugin_mutex
404 PL_lc_numeric_mutex_depth
412 Perl_clone_params_del
413 Perl_clone_params_new
432 Perl_stashpv_hvname_match
433 Perl_regdupe_internal
438 if ( $define{NO_LOCALE}
439 || (! $define{USE_ITHREADS} && ! $define{USE_THREAD_SAFE_LOCALE}))
441 ++$skip{$_} foreach qw(
447 unless ( $define{'HAS_NEWLOCALE'}
448 && $define{'HAS_FREELOCALE'}
449 && $define{'HAS_USELOCALE'}
450 && ! $define{'NO_POSIX_2008_LOCALE'})
452 ++$skip{$_} foreach qw(
454 PL_underlying_numeric_obj
458 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
459 ++$skip{$_} foreach qw(
469 Perl_load_module_nocontext
472 Perl_warner_nocontext
473 Perl_newSVpvf_nocontext
474 Perl_sv_catpvf_nocontext
475 Perl_sv_setpvf_nocontext
476 Perl_sv_catpvf_mg_nocontext
477 Perl_sv_setpvf_mg_nocontext
483 if ($define{USE_THREAD_SAFE_LOCALE}) {
484 ++$skip{PL_lc_numeric_mutex};
485 ++$skip{PL_lc_numeric_mutex_depth};
486 if (! $define{TS_W32_BROKEN_LOCALECONV}) {
487 ++$skip{PL_locale_mutex};
491 unless ($define{'USE_DTRACE'}) {
492 ++$skip{$_} foreach qw(
493 Perl_dtrace_probe_call
494 Perl_dtrace_probe_load
496 Perl_dtrace_probe_phase
500 unless ($define{'PERL_NEED_APPCTX'}) {
504 unless ($define{'PERL_NEED_TIMESBASE'}) {
505 ++$skip{PL_timesbase};
508 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
509 ++$skip{PL_sv_serial};
512 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
513 ++$skip{PL_dumper_fd};
516 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
517 ++$skip{Perl_gv_SVadd};
520 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
521 ++$skip{PL_pidstatus};
524 unless ($define{'PERL_TRACK_MEMPOOL'}) {
525 ++$skip{PL_memory_debug_header};
528 unless ($define{'MULTIPLICITY'}) {
529 ++$skip{$_} foreach qw(
531 PL_interp_size_5_18_0
539 unless ($define{'PERL_GLOBAL_STRUCT'}) {
540 ++$skip{PL_global_struct_size};
543 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
544 ++$skip{$_} foreach qw(
551 unless ($define{HAS_MMAP}) {
552 ++$skip{PL_mmap_page_size};
555 if ($define{HAS_SIGACTION}) {
556 ++$skip{PL_sig_trapped};
558 if ($ARGS{PLATFORM} eq 'vms') {
559 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
560 ++$skip{PL_sig_ignoring};
561 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
565 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
566 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
567 ++$skip{Perl_csighandler_init};
568 ++$skip{Perl_my_kill};
569 ++$skip{Perl_sig_to_vmscondition};
570 ++$skip{PL_sig_defaulting};
571 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
574 if ($define{'HAS_STRNLEN'})
576 ++$skip{Perl_my_strnlen};
579 unless ($define{USE_LOCALE_COLLATE}) {
580 ++$skip{$_} foreach qw(
583 PL_collation_standard
587 Perl_sv_collxfrm_flags
588 PL_strxfrm_NUL_replacement
589 PL_strxfrm_is_behaved
594 unless ($define{USE_LOCALE_NUMERIC}) {
595 ++$skip{$_} foreach qw(
600 PL_numeric_underlying
601 PL_numeric_underlying_is_standard
602 PL_underlying_numeric_obj
606 unless ($define{'USE_C_BACKTRACE'}) {
607 ++$skip{Perl_get_c_backtrace_dump};
608 ++$skip{Perl_dump_c_backtrace};
611 unless ($define{HAVE_INTERP_INTERN}) {
612 ++$skip{$_} foreach qw(
613 Perl_sys_intern_clear
620 if ($define{HAS_SIGNBIT}) {
621 ++$skip{Perl_signbit};
624 if ($define{'PERL_GLOBAL_STRUCT'}) {
625 readvar('perlvars.h', \%skip);
626 # This seems like the least ugly way to cope with the fact that PL_sh_path
627 # is mentioned in perlvar.h and globvar.sym, and always exported.
628 delete $skip{PL_sh_path};
629 ++$export{Perl_GetVars};
630 try_symbols(qw(PL_Vars PL_VarsPtr))
631 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
633 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
636 ++$skip{PL_op_exec_cnt}
637 unless $define{PERL_TRACE_OPS};
639 ++$skip{PL_hash_chars}
640 unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
642 # functions from *.sym files
644 my @syms = qw(globvar.sym);
646 # Symbols that are the public face of the PerlIO layers implementation
647 # These are in _addition to_ the public face of the abstraction
648 # and need to be exported to allow XS modules to implement layers
663 PerlIOBase_setlinebuf
702 Perl_PerlIO_context_layers
709 Perl_PerlIO_get_bufsiz
713 Perl_PerlIO_restore_errno
714 Perl_PerlIO_save_errno
717 Perl_PerlIO_set_ptrcnt
718 Perl_PerlIO_setlinebuf
726 if ($ARGS{PLATFORM} eq 'netware') {
727 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
730 # Export the symbols that make up the PerlIO abstraction, regardless
731 # of its implementation - read from a file
732 push @syms, 'perlio.sym';
734 # PerlIO with layers - export implementation
735 try_symbols(@layer_syms, 'perlsio_binmode');
738 unless ($define{'USE_QUADMATH'}) {
739 ++$skip{Perl_quadmath_format_needed};
740 ++$skip{Perl_quadmath_format_single};
743 ###############################################################################
745 # At this point all skip lists should be completed, as we are about to test
746 # many symbols against them.
750 my ($embed) = setup_embed($ARGS{TARG_DIR});
751 my $excludedre = $define{'NO_MATHOMS'} ? qr/[emib]/ : qr/[emi]/;
754 my ($flags, $retval, $func, @args) = @$_;
756 if (($flags =~ /[AXC]/ && $flags !~ $excludedre)
757 || (!$define{'NO_MATHOMS'} && $flags =~ /b/))
759 # public API, so export
761 # If a function is defined twice, for example before and after
762 # an #else, only export its name once. Important to do this test
763 # within the block, as the *first* definition may have flags which
764 # mean "don't export"
765 next if $seen{$func}++;
766 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
767 $func = "Perl_$func" if ($flags =~ /[pX]/ && $func !~ /^Perl_/);
768 ++$export{$func} unless exists $skip{$func};
774 my $syms = $ARGS{TARG_DIR} . $_;
775 open my $global, '<', $syms or die "failed to open $syms: $!\n";
777 next unless /^([A-Za-z].*)/;
779 ++$export{$symbol} unless exists $skip{$symbol};
785 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
786 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
787 # XXX AIX seems to want the perlvars.h symbols, for some reason
788 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
789 readvar('perlvars.h', \%export);
793 unless ($define{'PERL_GLOBAL_STRUCT'}) {
794 readvar('perlvars.h', \%export);
796 unless ($define{MULTIPLICITY}) {
797 readvar('intrpvar.h', \%export);
801 # Oddities from PerlIO
802 # All have alternate implementations in perlio.c, so always exist.
803 # Should they be considered to be part of the API?
812 if ($ARGS{PLATFORM} eq 'win32') {
878 win32_getprotobynumber
975 elsif ($ARGS{PLATFORM} eq 'vms') {
980 Perl_csighandler_init
983 Perl_fileify_dirspec_ts
984 Perl_fileify_dirspec_utf8
985 Perl_fileify_dirspec_utf8_ts
1017 Perl_pathify_dirspec
1018 Perl_pathify_dirspec_ts
1019 Perl_pathify_dirspec_utf8
1020 Perl_pathify_dirspec_utf8_ts
1028 Perl_rmsexpand_utf8_ts
1030 Perl_sig_to_vmscondition
1034 Perl_tounixpath_utf8
1035 Perl_tounixpath_utf8_ts
1038 Perl_tounixspec_utf8
1039 Perl_tounixspec_utf8_ts
1043 Perl_tovmspath_utf8_ts
1047 Perl_tovmsspec_utf8_ts
1049 Perl_vms_case_tolerant
1060 elsif ($ARGS{PLATFORM} eq 'os2') {
1103 XS_Cwd_current_drive
1105 XS_Cwd_extLibpath_set
1109 XS_Cwd_sys_is_absolute
1110 XS_Cwd_sys_is_relative
1111 XS_Cwd_sys_is_rooted
1112 XS_DynaLoader_mod2fname
1113 XS_File__Copy_syscopy
1117 Perl_Process_Messages
1129 elsif ($ARGS{PLATFORM} eq 'netware') {
1256 fnInsertHashListAddrs
1268 # When added this code was only run for Win32 (and WinCE at the time)
1269 # Currently only Win32 links static extensions into the shared library.
1270 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1271 # list of dynamic extensions, and the rules to build them)
1272 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1273 # static extensions with -fPIC, but links them to perl, not libperl.so
1274 # The VMS build scripts don't yet implement static extensions at all.
1276 if ($ARGS{PLATFORM} eq 'win32') {
1277 # records of type boot_module for statically linked modules (except Dynaloader)
1278 my $static_ext = $Config{static_ext} // "";
1279 $static_ext =~ s/\//__/g;
1280 $static_ext =~ s/\bDynaLoader\b//;
1281 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1282 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1285 if ($ARGS{PLATFORM} eq 'os2') {
1286 my (%mapped, @missing);
1287 open MAP, '<', 'miniperl.map' or die 'Cannot read miniperl.map';
1288 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1289 close MAP or die 'Cannot close miniperl.map';
1291 @missing = grep { !exists $mapped{$_} }
1293 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1294 delete $export{$_} foreach @missing;
1297 ###############################################################################
1299 # Now all symbols should be defined because next we are going to output them.
1301 # Start with platform specific headers:
1303 if ($ARGS{PLATFORM} eq 'win32') {
1304 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1305 : "perl$Config{api_revision}$Config{api_version}";
1306 print "LIBRARY $dll\n";
1307 # The DESCRIPTION module definition file statement is not supported
1309 if ($ARGS{CCTYPE} eq 'GCC') {
1310 print "DESCRIPTION 'Perl interpreter'\n";
1314 elsif ($ARGS{PLATFORM} eq 'os2') {
1315 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1316 $v .= '-thread' if $Config{archname} =~ /-thread/;
1317 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1318 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1319 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1320 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1321 print <<"---EOP---";
1322 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1326 DATA LOADONCALL NONSHARED MULTIPLE
1330 elsif ($ARGS{PLATFORM} eq 'aix') {
1331 my $OSVER = `uname -v`;
1333 my $OSREL = `uname -r`;
1335 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1341 elsif ($ARGS{PLATFORM} eq 'netware') {
1342 if ($ARGS{FILETYPE} eq 'def') {
1343 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1344 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1351 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1352 foreach my $symbol (@symbols) {
1353 if (PLATFORM eq 'win32') {
1354 # Remembering the origin file of each symbol is an alternative to PL_ matching
1355 if (substr($symbol, 0, 3) eq 'PL_') {
1356 print "\t$symbol DATA\n";
1359 print "\t$symbol\n";
1362 elsif (PLATFORM eq 'os2') {
1363 printf qq( %-31s \@%s\n),
1364 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1365 printf qq( %-31s \@%s\n),
1366 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1367 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1368 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1370 elsif (PLATFORM eq 'netware') {
1371 print "\t$symbol,\n";
1377 # Then platform specific footers.
1379 if ($ARGS{PLATFORM} eq 'os2') {
1384 Perl_OS2_handler_install
1386 ; LAST_ORDINAL=$sym_ord