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
111 |SPRINTF_RETURNS_STRLEN
113 |(?:PERL|USE|HAS)_\w+)\b/x;
117 # perl.h logic duplication begins
119 if ($define{USE_ITHREADS}) {
120 if (!$define{MULTIPLICITY}) {
121 $define{MULTIPLICITY} = 1;
125 $define{PERL_IMPLICIT_CONTEXT} ||=
126 $define{USE_ITHREADS} ||
127 $define{MULTIPLICITY} ;
129 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $^O ne 'darwin') {
130 $define{USE_REENTRANT_API} = 1;
133 # perl.h logic duplication ends
135 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
136 unless $ARGS{PLATFORM} eq 'test';
141 if ($ARGS{PLATFORM} eq 'os2') {
142 if (open my $fh, '<', 'perl5.def') {
144 last if /^\s*EXPORTS\b/;
147 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
148 # This allows skipping ordinals which were used in older versions
149 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
151 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
156 # All platforms export boot_DynaLoader unconditionally.
157 my %export = ( boot_DynaLoader => 1 );
160 foreach my $symbol (@_) {
161 ++$export{$symbol} unless exists $skip{$symbol};
166 # $hash is the hash that we're adding to. For one of our callers, it will
167 # actually be the skip hash but that doesn't affect the intent of what
168 # we're doing, as in that case we skip adding something to the skip hash
169 # for the second time.
171 my $file = $ARGS{TARG_DIR} . shift;
174 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
177 # All symbols have a Perl_ prefix because that's what embed.h sticks
178 # in front of them. The A?I?S?C? is strictly speaking wrong.
179 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
182 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
183 ++$hash->{$symbol} unless exists $skip{$var};
187 if ($ARGS{PLATFORM} ne 'os2') {
188 ++$skip{$_} foreach qw(
202 if ($ARGS{PLATFORM} eq 'vms') {
203 ++$skip{PL_statusvalue_posix};
204 # This is a wrapper if we have symlink, not a replacement
206 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
208 ++$skip{PL_statusvalue_vms};
209 if ($ARGS{PLATFORM} ne 'aix') {
210 ++$skip{$_} foreach qw(
222 if ($ARGS{PLATFORM} ne 'vms') {
223 # VMS does its own thing for these symbols.
224 ++$skip{$_} foreach qw(
225 PL_sig_handlers_initted
229 if ($ARGS{PLATFORM} ne 'win32') {
230 ++$skip{$_} foreach qw(
238 if ($ARGS{PLATFORM} ne 'win32') {
239 ++$skip{$_} foreach qw(
244 unless ($define{UNLINK_ALL_VERSIONS}) {
248 unless ($define{'DEBUGGING'}) {
249 ++$skip{$_} foreach qw(
256 Perl__setlocale_debug_string
265 if ($define{'PERL_IMPLICIT_SYS'}) {
266 ++$skip{$_} foreach qw(
270 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
271 ++$export{perl_clone_host} if $define{USE_ITHREADS};
274 ++$skip{$_} foreach qw(
289 unless ($define{'PERL_COPY_ON_WRITE'}) {
290 ++$skip{Perl_sv_setsv_cow};
293 unless ($define{PERL_SAWAMPERSAND}) {
294 ++$skip{PL_sawampersand};
297 unless ($define{'USE_REENTRANT_API'}) {
298 ++$skip{PL_reentrant_buffer};
301 if ($define{'MYMALLOC'}) {
310 unless ($define{USE_ITHREADS}) {
311 ++$skip{PL_malloc_mutex}
315 ++$skip{$_} foreach qw(
324 if ($define{'PERL_USE_SAFE_PUTENV'}) {
325 ++$skip{PL_use_safe_putenv};
328 unless ($define{'USE_ITHREADS'}) {
332 # USE_5005THREADS symbols. Kept as reference for easier removal
333 ++$skip{$_} foreach qw(
351 Perl_new_struct_thread
352 Perl_per_thread_magicals
360 unless ($define{'USE_ITHREADS'}) {
361 ++$skip{$_} foreach qw(
375 Perl_clone_params_del
376 Perl_clone_params_new
395 Perl_stashpv_hvname_match
396 Perl_regdupe_internal
401 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
402 ++$skip{$_} foreach qw(
411 Perl_load_module_nocontext
414 Perl_warner_nocontext
415 Perl_newSVpvf_nocontext
416 Perl_sv_catpvf_nocontext
417 Perl_sv_setpvf_nocontext
418 Perl_sv_catpvf_mg_nocontext
419 Perl_sv_setpvf_mg_nocontext
425 unless ($define{'PERL_OP_PARENT'}) {
426 ++$skip{$_} foreach qw(
431 if ($define{'NO_MATHOMS'}) {
432 # win32 builds happen in the win32/ subdirectory, but vms builds happen
433 # at the top level, so we need to look in two candidate locations for
434 # the mathoms.c file.
435 my ($file) = grep { -f } qw( mathoms.c ../mathoms.c )
436 or die "No mathoms.c file found in . or ..\n";
437 open my $mathoms, '<', $file
438 or die "Cannot open $file: $!\n";
440 ++$skip{$1} if /\A ( NATIVE_TO_NEED
442 | Perl_\w+ ) \s* \( /axms;
446 unless ($define{'PERL_NEED_APPCTX'}) {
450 unless ($define{'PERL_NEED_TIMESBASE'}) {
451 ++$skip{PL_timesbase};
454 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
455 ++$skip{PL_sv_serial};
458 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
459 ++$skip{PL_dumper_fd};
462 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
463 ++$skip{Perl_gv_SVadd};
466 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
467 ++$skip{Perl_my_sprintf};
470 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
471 ++$skip{PL_pidstatus};
474 unless ($define{'PERL_TRACK_MEMPOOL'}) {
475 ++$skip{PL_memory_debug_header};
478 unless ($define{'MULTIPLICITY'}) {
479 ++$skip{$_} foreach qw(
481 PL_interp_size_5_18_0
485 unless ($define{'PERL_GLOBAL_STRUCT'}) {
486 ++$skip{PL_global_struct_size};
489 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
490 ++$skip{$_} foreach qw(
496 unless ($define{HAS_MMAP}) {
497 ++$skip{PL_mmap_page_size};
500 if ($define{HAS_SIGACTION}) {
501 ++$skip{PL_sig_trapped};
503 if ($ARGS{PLATFORM} eq 'vms') {
504 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
505 ++$skip{PL_sig_ignoring};
506 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
510 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
511 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
512 ++$skip{Perl_csighandler_init};
513 ++$skip{Perl_my_kill};
514 ++$skip{Perl_sig_to_vmscondition};
515 ++$skip{PL_sig_defaulting};
516 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
519 unless ($define{USE_LOCALE_COLLATE}) {
520 ++$skip{$_} foreach qw(
523 PL_collation_standard
527 Perl_sv_collxfrm_flags
531 unless ($define{USE_LOCALE_NUMERIC}) {
532 ++$skip{$_} foreach qw(
540 unless ($define{'USE_C_BACKTRACE'}) {
541 ++$skip{Perl_get_c_backtrace_dump};
542 ++$skip{Perl_dump_c_backtrace};
545 unless ($define{HAVE_INTERP_INTERN}) {
546 ++$skip{$_} foreach qw(
547 Perl_sys_intern_clear
554 if ($define{HAS_SIGNBIT}) {
555 ++$skip{Perl_signbit};
558 if ($define{'PERL_GLOBAL_STRUCT'}) {
559 readvar('perlvars.h', \%skip);
560 # This seems like the least ugly way to cope with the fact that PL_sh_path
561 # is mentioned in perlvar.h and globvar.sym, and always exported.
562 delete $skip{PL_sh_path};
563 ++$export{Perl_GetVars};
564 try_symbols(qw(PL_Vars PL_VarsPtr))
565 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
567 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
570 ++$skip{PL_op_exec_cnt}
571 unless $define{PERL_TRACE_OPS};
573 # functions from *.sym files
575 my @syms = qw(globvar.sym);
577 # Symbols that are the public face of the PerlIO layers implementation
578 # These are in _addition to_ the public face of the abstraction
579 # and need to be exported to allow XS modules to implement layers
594 PerlIOBase_setlinebuf
633 Perl_PerlIO_context_layers
640 Perl_PerlIO_get_bufsiz
644 Perl_PerlIO_restore_errno
645 Perl_PerlIO_save_errno
648 Perl_PerlIO_set_ptrcnt
649 Perl_PerlIO_setlinebuf
657 if ($ARGS{PLATFORM} eq 'netware') {
658 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
661 # Export the symbols that make up the PerlIO abstraction, regardless
662 # of its implementation - read from a file
663 push @syms, 'perlio.sym';
665 # PerlIO with layers - export implementation
666 try_symbols(@layer_syms, 'perlsio_binmode');
669 unless ($define{'USE_QUADMATH'}) {
670 ++$skip{Perl_quadmath_format_needed};
671 ++$skip{Perl_quadmath_format_single};
674 ###############################################################################
676 # At this point all skip lists should be completed, as we are about to test
677 # many symbols against them.
681 my ($embed) = setup_embed($ARGS{TARG_DIR});
684 my ($flags, $retval, $func, @args) = @$_;
686 if ($flags =~ /[AX]/ && $flags !~ /[xmi]/ || $flags =~ /b/) {
687 # public API, so export
689 # If a function is defined twice, for example before and after
690 # an #else, only export its name once. Important to do this test
691 # within the block, as the *first* definition may have flags which
692 # mean "don't export"
693 next if $seen{$func}++;
694 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
695 $func = "Perl_$func" if ($flags =~ /[pbX]/ && $func !~ /^Perl_/);
696 ++$export{$func} unless exists $skip{$func};
702 my $syms = $ARGS{TARG_DIR} . $_;
703 open my $global, '<', $syms or die "failed to open $syms: $!\n";
705 next unless /^([A-Za-z].*)/;
707 ++$export{$symbol} unless exists $skip{$symbol};
713 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
714 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
715 # XXX AIX seems to want the perlvars.h symbols, for some reason
716 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
717 readvar('perlvars.h', \%export);
721 unless ($define{'PERL_GLOBAL_STRUCT'}) {
722 readvar('perlvars.h', \%export);
724 unless ($define{MULTIPLICITY}) {
725 readvar('intrpvar.h', \%export);
729 # Oddities from PerlIO
730 # All have alternate implementations in perlio.c, so always exist.
731 # Should they be considered to be part of the API?
740 if ($ARGS{PLATFORM} eq 'win32') {
750 if ($ARGS{PLATFORM} eq 'wince') {
751 ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
754 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
815 win32_getprotobynumber
911 elsif ($ARGS{PLATFORM} eq 'vms') {
916 Perl_csighandler_init
919 Perl_fileify_dirspec_ts
920 Perl_fileify_dirspec_utf8
921 Perl_fileify_dirspec_utf8_ts
954 Perl_pathify_dirspec_ts
955 Perl_pathify_dirspec_utf8
956 Perl_pathify_dirspec_utf8_ts
964 Perl_rmsexpand_utf8_ts
966 Perl_sig_to_vmscondition
971 Perl_tounixpath_utf8_ts
975 Perl_tounixspec_utf8_ts
979 Perl_tovmspath_utf8_ts
983 Perl_tovmsspec_utf8_ts
985 Perl_vms_case_tolerant
996 elsif ($ARGS{PLATFORM} eq 'os2') {
1039 XS_Cwd_current_drive
1041 XS_Cwd_extLibpath_set
1045 XS_Cwd_sys_is_absolute
1046 XS_Cwd_sys_is_relative
1047 XS_Cwd_sys_is_rooted
1048 XS_DynaLoader_mod2fname
1049 XS_File__Copy_syscopy
1053 Perl_Process_Messages
1065 elsif ($ARGS{PLATFORM} eq 'netware') {
1192 fnInsertHashListAddrs
1204 # When added this code was only run for Win32 and WinCE
1205 # Currently only Win32 links static extensions into the shared library.
1206 # The WinCE makefile doesn't appear to support static extensions, so this code
1207 # can't have any effect there.
1208 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1209 # list of dynamic extensions, and the rules to build them)
1210 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1211 # static extensions with -fPIC, but links them to perl, not libperl.so
1212 # The VMS build scripts don't yet implement static extensions at all.
1214 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1215 # records of type boot_module for statically linked modules (except Dynaloader)
1216 my $static_ext = $Config{static_ext} // "";
1217 $static_ext =~ s/\//__/g;
1218 $static_ext =~ s/\bDynaLoader\b//;
1219 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1220 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1223 if ($ARGS{PLATFORM} eq 'os2') {
1224 my (%mapped, @missing);
1225 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1226 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1227 close MAP or die 'Cannot close miniperl.map';
1229 @missing = grep { !exists $mapped{$_} }
1231 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1232 delete $export{$_} foreach @missing;
1235 ###############################################################################
1237 # Now all symbols should be defined because next we are going to output them.
1239 # Start with platform specific headers:
1241 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1242 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1243 : "perl$Config{api_revision}$Config{api_version}";
1244 print "LIBRARY $dll\n";
1245 # The DESCRIPTION module definition file statement is not supported
1247 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1248 print "DESCRIPTION 'Perl interpreter'\n";
1252 elsif ($ARGS{PLATFORM} eq 'os2') {
1253 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1254 $v .= '-thread' if $Config{archname} =~ /-thread/;
1255 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1256 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1257 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1258 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1259 print <<"---EOP---";
1260 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1264 DATA LOADONCALL NONSHARED MULTIPLE
1268 elsif ($ARGS{PLATFORM} eq 'aix') {
1269 my $OSVER = `uname -v`;
1271 my $OSREL = `uname -r`;
1273 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1279 elsif ($ARGS{PLATFORM} eq 'netware') {
1280 if ($ARGS{FILETYPE} eq 'def') {
1281 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1282 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1289 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1290 foreach my $symbol (@symbols) {
1291 if (PLATFORM eq 'win32' || PLATFORM eq 'wince') {
1292 # Remembering the origin file of each symbol is an alternative to PL_ matching
1293 if (substr($symbol, 0, 3) eq 'PL_') {
1294 print "\t$symbol DATA\n";
1297 print "\t$symbol\n";
1300 elsif (PLATFORM eq 'os2') {
1301 printf qq( %-31s \@%s\n),
1302 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1303 printf qq( %-31s \@%s\n),
1304 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1305 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1306 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1308 elsif (PLATFORM eq 'netware') {
1309 print "\t$symbol,\n";
1315 # Then platform specific footers.
1317 if ($ARGS{PLATFORM} eq 'os2') {
1322 Perl_OS2_handler_install
1324 ; LAST_ORDINAL=$sym_ord