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:
35 BEGIN { unshift @INC, "lib" }
39 my %ARGS = (CCTYPE => 'MSVC', TARG_DIR => '');
45 sub process_cc_flags {
46 foreach (map {split /\s+/, $_} @_) {
47 $define{$1} = $2 // 1 if /^-D(\w+)(?:=(.+))?/;
53 if ($flag =~ /^(?:CC_FLAGS=)?(-D\w.*)/) {
55 } elsif ($flag =~ /^(CCTYPE|FILETYPE|PLATFORM|TARG_DIR)=(.+)$/) {
57 } elsif ($flag eq '--sort-fold') {
62 require "$ARGS{TARG_DIR}regen/embed_lib.pl";
65 my @PLATFORM = qw(aix win32 wince os2 netware vms test);
67 @PLATFORM{@PLATFORM} = ();
69 die "PLATFORM undefined, must be one of: @PLATFORM\n"
70 unless defined $ARGS{PLATFORM};
71 die "PLATFORM must be one of: @PLATFORM\n"
72 unless exists $PLATFORM{$ARGS{PLATFORM}};
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(
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 unless ($define{'PERL_OLD_COPY_ON_WRITE'}
289 || $define{'PERL_NEW_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
424 if ($define{'NO_MATHOMS'}) {
425 ++$skip{$_} foreach qw(
434 Perl_fprintf_nocontext
461 Perl_is_uni_alnumc_lc
475 Perl_is_uni_idfirst_lc
487 Perl_is_uni_xdigit_lc
501 Perl_is_utf8_perl_space
502 Perl_is_utf8_perl_word
503 Perl_is_utf8_posix_digit
507 Perl_is_utf8_string_loc
511 Perl_is_utf8_xidfirst
519 Perl_printf_nocontext
527 Perl_save_mortalizesv
534 Perl_sv_2pvbyte_nolen
535 Perl_sv_2pvutf8_nolen
573 Perl_valid_utf8_to_uvuni
577 unless ($define{'PERL_NEED_APPCTX'}) {
581 unless ($define{'PERL_NEED_TIMESBASE'}) {
582 ++$skip{PL_timesbase};
585 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
586 ++$skip{PL_sv_serial};
589 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
590 ++$skip{PL_dumper_fd};
593 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
594 ++$skip{Perl_gv_SVadd};
597 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
598 ++$skip{Perl_my_sprintf};
601 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
602 ++$skip{PL_pidstatus};
605 unless ($define{'PERL_TRACK_MEMPOOL'}) {
606 ++$skip{PL_memory_debug_header};
609 unless ($define{'MULTIPLICITY'}) {
610 ++$skip{$_} foreach qw(
612 PL_interp_size_5_18_0
616 unless ($define{'PERL_GLOBAL_STRUCT'}) {
617 ++$skip{PL_global_struct_size};
620 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
621 ++$skip{$_} foreach qw(
627 unless ($define{HAS_MMAP}) {
628 ++$skip{PL_mmap_page_size};
631 if ($define{HAS_SIGACTION}) {
632 ++$skip{PL_sig_trapped};
634 if ($ARGS{PLATFORM} eq 'vms') {
635 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
636 ++$skip{PL_sig_ignoring};
637 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
641 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
642 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
643 ++$skip{Perl_csighandler_init};
644 ++$skip{Perl_my_kill};
645 ++$skip{Perl_sig_to_vmscondition};
646 ++$skip{PL_sig_defaulting};
647 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
650 unless ($define{USE_LOCALE_COLLATE}) {
651 ++$skip{$_} foreach qw(
654 PL_collation_standard
658 Perl_sv_collxfrm_flags
662 unless ($define{USE_LOCALE_NUMERIC}) {
663 ++$skip{$_} foreach qw(
671 unless ($define{'USE_C_BACKTRACE'}) {
672 ++$skip{Perl_get_c_backtrace_dump};
673 ++$skip{Perl_dump_c_backtrace};
676 unless ($define{HAVE_INTERP_INTERN}) {
677 ++$skip{$_} foreach qw(
678 Perl_sys_intern_clear
685 if ($define{HAS_SIGNBIT}) {
686 ++$skip{Perl_signbit};
689 if ($define{'PERL_GLOBAL_STRUCT'}) {
690 readvar('perlvars.h', \%skip);
691 # This seems like the least ugly way to cope with the fact that PL_sh_path
692 # is mentioned in perlvar.h and globvar.sym, and always exported.
693 delete $skip{PL_sh_path};
694 ++$export{Perl_GetVars};
695 try_symbols(qw(PL_Vars PL_VarsPtr))
696 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
698 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
701 ++$skip{PL_op_exec_cnt}
702 unless $define{PERL_TRACE_OPS};
704 # functions from *.sym files
706 my @syms = qw(globvar.sym);
708 # Symbols that are the public face of the PerlIO layers implementation
709 # These are in _addition to_ the public face of the abstraction
710 # and need to be exported to allow XS modules to implement layers
725 PerlIOBase_setlinebuf
764 Perl_PerlIO_context_layers
771 Perl_PerlIO_get_bufsiz
775 Perl_PerlIO_restore_errno
776 Perl_PerlIO_save_errno
779 Perl_PerlIO_set_ptrcnt
780 Perl_PerlIO_setlinebuf
788 if ($ARGS{PLATFORM} eq 'netware') {
789 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
792 if ($define{'USE_PERLIO'}) {
793 # Export the symbols that make up the PerlIO abstraction, regardless
794 # of its implementation - read from a file
795 push @syms, 'perlio.sym';
797 # PerlIO with layers - export implementation
798 try_symbols(@layer_syms, 'perlsio_binmode');
801 # Skip the PerlIO layer symbols - although
802 # nothing should have exported them anyway.
803 ++$skip{$_} foreach @layer_syms;
804 ++$skip{$_} foreach qw(
811 PL_perlio_fd_refcnt_size
815 # Also do NOT add abstraction symbols from $perlio_sym
816 # abstraction is done as #define to stdio
817 # Remaining remnants that _may_ be functions are handled below.
820 unless ($define{'USE_QUADMATH'}) {
821 ++$skip{Perl_quadmath_format_needed};
822 ++$skip{Perl_quadmath_format_single};
825 ###############################################################################
827 # At this point all skip lists should be completed, as we are about to test
828 # many symbols against them.
832 my ($embed) = setup_embed($ARGS{TARG_DIR});
835 my ($flags, $retval, $func, @args) = @$_;
837 if ($flags =~ /[AX]/ && $flags !~ /[xmi]/ || $flags =~ /b/) {
838 # public API, so export
840 # If a function is defined twice, for example before and after
841 # an #else, only export its name once. Important to do this test
842 # within the block, as the *first* definition may have flags which
843 # mean "don't export"
844 next if $seen{$func}++;
845 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
846 $func = "Perl_$func" if ($flags =~ /[pbX]/ && $func !~ /^Perl_/);
847 ++$export{$func} unless exists $skip{$func};
853 my $syms = $ARGS{TARG_DIR} . $_;
854 open my $global, '<', $syms or die "failed to open $syms: $!\n";
856 next unless /^([A-Za-z].*)/;
858 ++$export{$symbol} unless exists $skip{$symbol};
864 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
865 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
866 # XXX AIX seems to want the perlvars.h symbols, for some reason
867 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
868 readvar('perlvars.h', \%export);
872 unless ($define{'PERL_GLOBAL_STRUCT'}) {
873 readvar('perlvars.h', \%export);
875 unless ($define{MULTIPLICITY}) {
876 readvar('intrpvar.h', \%export);
880 # Oddities from PerlIO
881 # All have alternate implementations in perlio.c, so always exist.
882 # Should they be considered to be part of the API?
891 if ($ARGS{PLATFORM} eq 'win32') {
901 if ($ARGS{PLATFORM} eq 'wince') {
902 ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
905 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
966 win32_getprotobynumber
1062 elsif ($ARGS{PLATFORM} eq 'vms') {
1067 Perl_csighandler_init
1069 Perl_fileify_dirspec
1070 Perl_fileify_dirspec_ts
1071 Perl_fileify_dirspec_utf8
1072 Perl_fileify_dirspec_utf8_ts
1104 Perl_pathify_dirspec
1105 Perl_pathify_dirspec_ts
1106 Perl_pathify_dirspec_utf8
1107 Perl_pathify_dirspec_utf8_ts
1115 Perl_rmsexpand_utf8_ts
1117 Perl_sig_to_vmscondition
1121 Perl_tounixpath_utf8
1122 Perl_tounixpath_utf8_ts
1125 Perl_tounixspec_utf8
1126 Perl_tounixspec_utf8_ts
1130 Perl_tovmspath_utf8_ts
1134 Perl_tovmsspec_utf8_ts
1136 Perl_vms_case_tolerant
1147 elsif ($ARGS{PLATFORM} eq 'os2') {
1190 XS_Cwd_current_drive
1192 XS_Cwd_extLibpath_set
1196 XS_Cwd_sys_is_absolute
1197 XS_Cwd_sys_is_relative
1198 XS_Cwd_sys_is_rooted
1199 XS_DynaLoader_mod2fname
1200 XS_File__Copy_syscopy
1204 Perl_Process_Messages
1216 elsif ($ARGS{PLATFORM} eq 'netware') {
1343 fnInsertHashListAddrs
1355 # When added this code was only run for Win32 and WinCE
1356 # Currently only Win32 links static extensions into the shared library.
1357 # The WinCE makefile doesn't appear to support static extensions, so this code
1358 # can't have any effect there.
1359 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1360 # list of dynamic extensions, and the rules to build them)
1361 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1362 # static extensions with -fPIC, but links them to perl, not libperl.so
1363 # The VMS build scripts don't yet implement static extensions at all.
1365 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1366 # records of type boot_module for statically linked modules (except Dynaloader)
1367 my $static_ext = $Config{static_ext} // "";
1368 $static_ext =~ s/\//__/g;
1369 $static_ext =~ s/\bDynaLoader\b//;
1370 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1371 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1374 if ($ARGS{PLATFORM} eq 'os2') {
1375 my (%mapped, @missing);
1376 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1377 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1378 close MAP or die 'Cannot close miniperl.map';
1380 @missing = grep { !exists $mapped{$_} }
1382 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1383 delete $export{$_} foreach @missing;
1386 ###############################################################################
1388 # Now all symbols should be defined because next we are going to output them.
1390 # Start with platform specific headers:
1392 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1393 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1394 : "perl$Config{api_revision}$Config{api_version}";
1395 print "LIBRARY $dll\n";
1396 # The DESCRIPTION module definition file statement is not supported
1398 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1399 print "DESCRIPTION 'Perl interpreter'\n";
1403 elsif ($ARGS{PLATFORM} eq 'os2') {
1404 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1405 $v .= '-thread' if $Config{archname} =~ /-thread/;
1406 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1407 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1408 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1409 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1410 print <<"---EOP---";
1411 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1415 DATA LOADONCALL NONSHARED MULTIPLE
1419 elsif ($ARGS{PLATFORM} eq 'aix') {
1420 my $OSVER = `uname -v`;
1422 my $OSREL = `uname -r`;
1424 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1430 elsif ($ARGS{PLATFORM} eq 'netware') {
1431 if ($ARGS{FILETYPE} eq 'def') {
1432 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1433 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1440 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1441 foreach my $symbol (@symbols) {
1442 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1443 print "\t$symbol\n";
1445 elsif ($ARGS{PLATFORM} eq 'os2') {
1446 printf qq( %-31s \@%s\n),
1447 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1448 printf qq( %-31s \@%s\n),
1449 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1450 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1451 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1453 elsif ($ARGS{PLATFORM} eq 'netware') {
1454 print "\t$symbol,\n";
1460 # Then platform specific footers.
1462 if ($ARGS{PLATFORM} eq 'os2') {
1467 Perl_OS2_handler_install
1469 ; LAST_ORDINAL=$sym_ord