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' && $ARGS{PLATFORM} ne 'netware') {
129 $define{USE_REENTRANT_API} = 1;
132 if ( $define{USE_ITHREADS}
133 && $define{HAS_SETLOCALE}
134 && ! $define{NO_LOCALE}
135 && ! $define{NO_POSIX_2008_LOCALE})
137 $define{HAS_POSIX_2008_LOCALE} = 1 if $define{HAS_NEWLOCALE}
138 && $define{HAS_FREELOCALE}
139 && $define{HAS_USELOCALE};
140 my $cctype = $ARGS{CCTYPE} =~ s/MSVC//r;
141 if ( ! $define{NO_THREAD_SAFE_LOCALE}
142 && ( $define{HAS_POSIX_2008_LOCALE}
143 || ($ARGS{PLATFORM} eq 'win32' && ( $cctype !~ /\D/
146 $define{USE_THREAD_SAFE_LOCALE} = 1;
147 $define{USE_POSIX_2008_LOCALE} = 1 if $define{HAS_POSIX_2008_LOCALE};
150 if ( $ARGS{PLATFORM} eq 'win32'
151 && $define{USE_THREAD_SAFE_LOCALE}
154 $define{TS_W32_BROKEN_LOCALECONV} = 1;
158 # perl.h logic duplication ends
160 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
161 unless $ARGS{PLATFORM} eq 'test';
166 if ($ARGS{PLATFORM} eq 'os2') {
167 if (open my $fh, '<', 'perl5.def') {
169 last if /^\s*EXPORTS\b/;
172 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
173 # This allows skipping ordinals which were used in older versions
174 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
176 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
181 # All platforms export boot_DynaLoader unconditionally.
182 my %export = ( boot_DynaLoader => 1 );
185 foreach my $symbol (@_) {
186 ++$export{$symbol} unless exists $skip{$symbol};
191 # $hash is the hash that we're adding to. For one of our callers, it will
192 # actually be the skip hash but that doesn't affect the intent of what
193 # we're doing, as in that case we skip adding something to the skip hash
194 # for the second time.
196 my $file = $ARGS{TARG_DIR} . shift;
199 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
202 # All symbols have a Perl_ prefix because that's what embed.h sticks
203 # in front of them. The A?I?S?C? is strictly speaking wrong.
204 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
207 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
208 ++$hash->{$symbol} unless exists $skip{$var};
212 if ($ARGS{PLATFORM} ne 'os2') {
213 ++$skip{$_} foreach qw(
227 if ($ARGS{PLATFORM} eq 'vms') {
228 ++$skip{PL_statusvalue_posix};
229 # This is a wrapper if we have symlink, not a replacement
231 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
233 ++$skip{PL_statusvalue_vms};
234 ++$skip{PL_perllib_sep};
235 if ($ARGS{PLATFORM} ne 'aix') {
236 ++$skip{$_} foreach qw(
247 if ($ARGS{PLATFORM} ne 'vms') {
248 # VMS does its own thing for these symbols.
249 ++$skip{$_} foreach qw(
250 PL_sig_handlers_initted
254 if ($ARGS{PLATFORM} ne 'win32') {
255 ++$skip{$_} foreach qw(
263 if ($ARGS{PLATFORM} ne 'win32') {
264 ++$skip{$_} foreach qw(
269 unless ($define{UNLINK_ALL_VERSIONS}) {
273 unless ($define{'DEBUGGING'}) {
274 ++$skip{$_} foreach qw(
281 Perl__setlocale_debug_string
290 if ($define{'PERL_IMPLICIT_SYS'}) {
291 ++$skip{$_} foreach qw(
295 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
296 ++$export{perl_clone_host} if $define{USE_ITHREADS};
299 ++$skip{$_} foreach qw(
314 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
315 ++$skip{Perl_sv_setsv_cow};
318 unless ($define{PERL_SAWAMPERSAND}) {
319 ++$skip{PL_sawampersand};
322 unless ($define{'USE_REENTRANT_API'}) {
323 ++$skip{PL_reentrant_buffer};
326 if ($define{'MYMALLOC'}) {
335 unless ($define{USE_ITHREADS}) {
336 ++$skip{PL_malloc_mutex}
340 ++$skip{$_} foreach qw(
349 if ($define{'PERL_USE_SAFE_PUTENV'}) {
350 ++$skip{PL_use_safe_putenv};
353 unless ($define{'USE_ITHREADS'}) {
357 # USE_5005THREADS symbols. Kept as reference for easier removal
358 ++$skip{$_} foreach qw(
376 Perl_new_struct_thread
377 Perl_per_thread_magicals
385 unless ($define{'USE_ITHREADS'}) {
386 ++$skip{$_} foreach qw(
387 PL_keyword_plugin_mutex
397 PL_lc_numeric_mutex_depth
405 Perl_clone_params_del
406 Perl_clone_params_new
425 Perl_stashpv_hvname_match
426 Perl_regdupe_internal
432 unless ( $define{'HAS_NEWLOCALE'}
433 && $define{'HAS_FREELOCALE'}
434 && $define{'HAS_USELOCALE'}
435 && ! $define{'NO_POSIX_2008_LOCALE'})
437 ++$skip{$_} foreach qw(
439 PL_underlying_numeric_obj
443 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
444 ++$skip{$_} foreach qw(
453 Perl_load_module_nocontext
456 Perl_warner_nocontext
457 Perl_newSVpvf_nocontext
458 Perl_sv_catpvf_nocontext
459 Perl_sv_setpvf_nocontext
460 Perl_sv_catpvf_mg_nocontext
461 Perl_sv_setpvf_mg_nocontext
467 if ($define{USE_THREAD_SAFE_LOCALE}) {
468 ++$skip{PL_lc_numeric_mutex};
469 ++$skip{PL_lc_numeric_mutex_depth};
470 if (! $define{TS_W32_BROKEN_LOCALECONV}) {
471 ++$skip{PL_locale_mutex};
475 unless ($define{'PERL_OP_PARENT'}) {
476 ++$skip{$_} foreach qw(
481 unless ($define{'USE_DTRACE'}) {
482 ++$skip{$_} foreach qw(
483 Perl_dtrace_probe_call
484 Perl_dtrace_probe_load
486 Perl_dtrace_probe_phase
490 unless ($define{'PERL_NEED_APPCTX'}) {
494 unless ($define{'PERL_NEED_TIMESBASE'}) {
495 ++$skip{PL_timesbase};
498 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
499 ++$skip{PL_sv_serial};
502 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
503 ++$skip{PL_dumper_fd};
506 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
507 ++$skip{Perl_gv_SVadd};
510 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
511 ++$skip{PL_pidstatus};
514 unless ($define{'PERL_TRACK_MEMPOOL'}) {
515 ++$skip{PL_memory_debug_header};
518 unless ($define{'MULTIPLICITY'}) {
519 ++$skip{$_} foreach qw(
521 PL_interp_size_5_18_0
529 unless ($define{'PERL_GLOBAL_STRUCT'}) {
530 ++$skip{PL_global_struct_size};
533 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
534 ++$skip{$_} foreach qw(
540 unless ($define{HAS_MMAP}) {
541 ++$skip{PL_mmap_page_size};
544 if ($define{HAS_SIGACTION}) {
545 ++$skip{PL_sig_trapped};
547 if ($ARGS{PLATFORM} eq 'vms') {
548 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
549 ++$skip{PL_sig_ignoring};
550 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
554 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
555 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
556 ++$skip{Perl_csighandler_init};
557 ++$skip{Perl_my_kill};
558 ++$skip{Perl_sig_to_vmscondition};
559 ++$skip{PL_sig_defaulting};
560 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
563 if ($define{'HAS_STRNLEN'})
565 ++$skip{Perl_my_strnlen};
568 unless ($define{USE_LOCALE_COLLATE}) {
569 ++$skip{$_} foreach qw(
572 PL_collation_standard
576 Perl_sv_collxfrm_flags
577 PL_strxfrm_NUL_replacement
578 PL_strxfrm_is_behaved
583 unless ($define{USE_LOCALE_NUMERIC}) {
584 ++$skip{$_} foreach qw(
589 PL_numeric_underlying
590 PL_numeric_underlying_is_standard
591 PL_underlying_numeric_obj
595 unless ($define{'USE_C_BACKTRACE'}) {
596 ++$skip{Perl_get_c_backtrace_dump};
597 ++$skip{Perl_dump_c_backtrace};
600 unless ($define{HAVE_INTERP_INTERN}) {
601 ++$skip{$_} foreach qw(
602 Perl_sys_intern_clear
609 if ($define{HAS_SIGNBIT}) {
610 ++$skip{Perl_signbit};
613 if ($define{'PERL_GLOBAL_STRUCT'}) {
614 readvar('perlvars.h', \%skip);
615 # This seems like the least ugly way to cope with the fact that PL_sh_path
616 # is mentioned in perlvar.h and globvar.sym, and always exported.
617 delete $skip{PL_sh_path};
618 ++$export{Perl_GetVars};
619 try_symbols(qw(PL_Vars PL_VarsPtr))
620 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
622 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
625 ++$skip{PL_op_exec_cnt}
626 unless $define{PERL_TRACE_OPS};
628 ++$skip{PL_hash_chars}
629 unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
631 # functions from *.sym files
633 my @syms = qw(globvar.sym);
635 # Symbols that are the public face of the PerlIO layers implementation
636 # These are in _addition to_ the public face of the abstraction
637 # and need to be exported to allow XS modules to implement layers
652 PerlIOBase_setlinebuf
691 Perl_PerlIO_context_layers
698 Perl_PerlIO_get_bufsiz
702 Perl_PerlIO_restore_errno
703 Perl_PerlIO_save_errno
706 Perl_PerlIO_set_ptrcnt
707 Perl_PerlIO_setlinebuf
715 if ($ARGS{PLATFORM} eq 'netware') {
716 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
719 # Export the symbols that make up the PerlIO abstraction, regardless
720 # of its implementation - read from a file
721 push @syms, 'perlio.sym';
723 # PerlIO with layers - export implementation
724 try_symbols(@layer_syms, 'perlsio_binmode');
727 unless ($define{'USE_QUADMATH'}) {
728 ++$skip{Perl_quadmath_format_needed};
729 ++$skip{Perl_quadmath_format_single};
732 ###############################################################################
734 # At this point all skip lists should be completed, as we are about to test
735 # many symbols against them.
739 my ($embed) = setup_embed($ARGS{TARG_DIR});
740 my $excludedre = $define{'NO_MATHOMS'} ? qr/[xmib]/ : qr/[xmi]/;
743 my ($flags, $retval, $func, @args) = @$_;
745 if (($flags =~ /[AX]/ && $flags !~ $excludedre)
746 || (!$define{'NO_MATHOMS'} && $flags =~ /b/))
748 # public API, so export
750 # If a function is defined twice, for example before and after
751 # an #else, only export its name once. Important to do this test
752 # within the block, as the *first* definition may have flags which
753 # mean "don't export"
754 next if $seen{$func}++;
755 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
756 $func = "Perl_$func" if ($flags =~ /[pX]/ && $func !~ /^Perl_/);
757 ++$export{$func} unless exists $skip{$func};
763 my $syms = $ARGS{TARG_DIR} . $_;
764 open my $global, '<', $syms or die "failed to open $syms: $!\n";
766 next unless /^([A-Za-z].*)/;
768 ++$export{$symbol} unless exists $skip{$symbol};
774 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
775 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
776 # XXX AIX seems to want the perlvars.h symbols, for some reason
777 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
778 readvar('perlvars.h', \%export);
782 unless ($define{'PERL_GLOBAL_STRUCT'}) {
783 readvar('perlvars.h', \%export);
785 unless ($define{MULTIPLICITY}) {
786 readvar('intrpvar.h', \%export);
790 # Oddities from PerlIO
791 # All have alternate implementations in perlio.c, so always exist.
792 # Should they be considered to be part of the API?
801 if ($ARGS{PLATFORM} eq 'win32') {
811 if ($ARGS{PLATFORM} eq 'wince') {
812 ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
815 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
876 win32_getprotobynumber
973 elsif ($ARGS{PLATFORM} eq 'vms') {
978 Perl_csighandler_init
981 Perl_fileify_dirspec_ts
982 Perl_fileify_dirspec_utf8
983 Perl_fileify_dirspec_utf8_ts
1015 Perl_pathify_dirspec
1016 Perl_pathify_dirspec_ts
1017 Perl_pathify_dirspec_utf8
1018 Perl_pathify_dirspec_utf8_ts
1026 Perl_rmsexpand_utf8_ts
1028 Perl_sig_to_vmscondition
1032 Perl_tounixpath_utf8
1033 Perl_tounixpath_utf8_ts
1036 Perl_tounixspec_utf8
1037 Perl_tounixspec_utf8_ts
1041 Perl_tovmspath_utf8_ts
1045 Perl_tovmsspec_utf8_ts
1047 Perl_vms_case_tolerant
1058 elsif ($ARGS{PLATFORM} eq 'os2') {
1101 XS_Cwd_current_drive
1103 XS_Cwd_extLibpath_set
1107 XS_Cwd_sys_is_absolute
1108 XS_Cwd_sys_is_relative
1109 XS_Cwd_sys_is_rooted
1110 XS_DynaLoader_mod2fname
1111 XS_File__Copy_syscopy
1115 Perl_Process_Messages
1127 elsif ($ARGS{PLATFORM} eq 'netware') {
1254 fnInsertHashListAddrs
1266 # When added this code was only run for Win32 and WinCE
1267 # Currently only Win32 links static extensions into the shared library.
1268 # The WinCE makefile doesn't appear to support static extensions, so this code
1269 # can't have any effect there.
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} =~ /^win(?:32|ce)$/) {
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} =~ /^win(?:32|ce)$/) {
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} =~ /^(?:MSVC60|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' || PLATFORM eq 'wince') {
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