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(
263 if ($define{'PERL_IMPLICIT_SYS'}) {
264 ++$skip{$_} foreach qw(
268 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
269 ++$export{perl_clone_host} if $define{USE_ITHREADS};
272 ++$skip{$_} foreach qw(
287 unless ($define{'PERL_OLD_COPY_ON_WRITE'}
288 || $define{'PERL_NEW_COPY_ON_WRITE'}) {
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(
374 Perl_clone_params_del
375 Perl_clone_params_new
394 Perl_stashpv_hvname_match
395 Perl_regdupe_internal
400 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
401 ++$skip{$_} foreach qw(
410 Perl_load_module_nocontext
413 Perl_warner_nocontext
414 Perl_newSVpvf_nocontext
415 Perl_sv_catpvf_nocontext
416 Perl_sv_setpvf_nocontext
417 Perl_sv_catpvf_mg_nocontext
418 Perl_sv_setpvf_mg_nocontext
424 unless ($define{'PERL_NEED_APPCTX'}) {
428 unless ($define{'PERL_NEED_TIMESBASE'}) {
429 ++$skip{PL_timesbase};
432 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
433 ++$skip{PL_sv_serial};
436 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
437 ++$skip{PL_dumper_fd};
440 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
441 ++$skip{Perl_gv_SVadd};
444 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
445 ++$skip{Perl_my_sprintf};
448 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
449 ++$skip{PL_pidstatus};
452 unless ($define{'PERL_TRACK_MEMPOOL'}) {
453 ++$skip{PL_memory_debug_header};
456 unless ($define{PERL_MAD}) {
457 ++$skip{$_} foreach qw(
463 unless ($define{'MULTIPLICITY'}) {
464 ++$skip{$_} foreach qw(
466 PL_interp_size_5_18_0
470 unless ($define{'PERL_GLOBAL_STRUCT'}) {
471 ++$skip{PL_global_struct_size};
474 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
475 ++$skip{$_} foreach qw(
481 unless ($define{HAS_MMAP}) {
482 ++$skip{PL_mmap_page_size};
485 if ($define{HAS_SIGACTION}) {
486 ++$skip{PL_sig_trapped};
488 if ($ARGS{PLATFORM} eq 'vms') {
489 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
490 ++$skip{PL_sig_ignoring};
491 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
495 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
496 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
497 ++$skip{Perl_csighandler_init};
498 ++$skip{Perl_my_kill};
499 ++$skip{Perl_sig_to_vmscondition};
500 ++$skip{PL_sig_defaulting};
501 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
504 unless ($define{USE_LOCALE_COLLATE}) {
505 ++$skip{$_} foreach qw(
508 PL_collation_standard
512 Perl_sv_collxfrm_flags
516 unless ($define{USE_LOCALE_NUMERIC}) {
517 ++$skip{$_} foreach qw(
525 unless ($define{HAVE_INTERP_INTERN}) {
526 ++$skip{$_} foreach qw(
527 Perl_sys_intern_clear
534 if ($define{HAS_SIGNBIT}) {
535 ++$skip{Perl_signbit};
538 if ($define{'PERL_GLOBAL_STRUCT'}) {
539 readvar('perlvars.h', \%skip);
540 # This seems like the least ugly way to cope with the fact that PL_sh_path
541 # is mentioned in perlvar.h and globvar.sym, and always exported.
542 delete $skip{PL_sh_path};
543 ++$export{Perl_GetVars};
544 try_symbols(qw(PL_Vars PL_VarsPtr))
545 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
547 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
550 ++$skip{PL_op_exec_cnt}
551 unless $define{PERL_TRACE_OPS};
553 # functions from *.sym files
555 my @syms = qw(globvar.sym);
557 # Symbols that are the public face of the PerlIO layers implementation
558 # These are in _addition to_ the public face of the abstraction
559 # and need to be exported to allow XS modules to implement layers
574 PerlIOBase_setlinebuf
613 Perl_PerlIO_context_layers
620 Perl_PerlIO_get_bufsiz
626 Perl_PerlIO_set_ptrcnt
627 Perl_PerlIO_setlinebuf
635 if ($ARGS{PLATFORM} eq 'netware') {
636 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
639 if ($define{'USE_PERLIO'}) {
640 # Export the symbols that make up the PerlIO abstraction, regardless
641 # of its implementation - read from a file
642 push @syms, 'perlio.sym';
644 # PerlIO with layers - export implementation
645 try_symbols(@layer_syms, 'perlsio_binmode');
648 # Skip the PerlIO layer symbols - although
649 # nothing should have exported them anyway.
650 ++$skip{$_} foreach @layer_syms;
651 ++$skip{$_} foreach qw(
658 PL_perlio_fd_refcnt_size
662 # Also do NOT add abstraction symbols from $perlio_sym
663 # abstraction is done as #define to stdio
664 # Remaining remnants that _may_ be functions are handled below.
667 ###############################################################################
669 # At this point all skip lists should be completed, as we are about to test
670 # many symbols against them.
674 my ($embed) = setup_embed($ARGS{TARG_DIR});
677 my ($flags, $retval, $func, @args) = @$_;
679 if ($flags =~ /[AX]/ && $flags !~ /[xmi]/ || $flags =~ /b/) {
680 # public API, so export
682 # If a function is defined twice, for example before and after
683 # an #else, only export its name once. Important to do this test
684 # within the block, as the *first* definition may have flags which
685 # mean "don't export"
686 next if $seen{$func}++;
687 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
688 $func = "Perl_$func" if ($flags =~ /[pbX]/ && $func !~ /^Perl_/);
689 ++$export{$func} unless exists $skip{$func};
695 my $syms = $ARGS{TARG_DIR} . $_;
696 open my $global, '<', $syms or die "failed to open $syms: $!\n";
697 # Functions already have a Perl_ prefix
698 # Variables need a PL_ prefix
699 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
701 next unless /^([A-Za-z].*)/;
702 my $symbol = "$prefix$1";
703 ++$export{$symbol} unless exists $skip{$symbol};
709 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
710 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
711 # XXX AIX seems to want the perlvars.h symbols, for some reason
712 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
713 readvar('perlvars.h', \%export);
717 unless ($define{'PERL_GLOBAL_STRUCT'}) {
718 readvar('perlvars.h', \%export);
720 unless ($define{MULTIPLICITY}) {
721 readvar('intrpvar.h', \%export);
725 # Oddities from PerlIO
726 # All have alternate implementations in perlio.c, so always exist.
727 # Should they be considered to be part of the API?
736 if ($ARGS{PLATFORM} eq 'win32') {
746 if ($ARGS{PLATFORM} eq 'wince') {
747 ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
750 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
811 win32_getprotobynumber
907 elsif ($ARGS{PLATFORM} eq 'vms') {
912 Perl_csighandler_init
915 Perl_fileify_dirspec_ts
916 Perl_fileify_dirspec_utf8
917 Perl_fileify_dirspec_utf8_ts
950 Perl_pathify_dirspec_ts
951 Perl_pathify_dirspec_utf8
952 Perl_pathify_dirspec_utf8_ts
960 Perl_rmsexpand_utf8_ts
962 Perl_sig_to_vmscondition
967 Perl_tounixpath_utf8_ts
971 Perl_tounixspec_utf8_ts
975 Perl_tovmspath_utf8_ts
979 Perl_tovmsspec_utf8_ts
981 Perl_vms_case_tolerant
992 elsif ($ARGS{PLATFORM} eq 'os2') {
1035 XS_Cwd_current_drive
1037 XS_Cwd_extLibpath_set
1041 XS_Cwd_sys_is_absolute
1042 XS_Cwd_sys_is_relative
1043 XS_Cwd_sys_is_rooted
1044 XS_DynaLoader_mod2fname
1045 XS_File__Copy_syscopy
1049 Perl_Process_Messages
1061 elsif ($ARGS{PLATFORM} eq 'netware') {
1188 fnInsertHashListAddrs
1200 # When added this code was only run for Win32 and WinCE
1201 # Currently only Win32 links static extensions into the shared library.
1202 # The WinCE makefile doesn't appear to support static extensions, so this code
1203 # can't have any effect there.
1204 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1205 # list of dynamic extensions, and the rules to build them)
1206 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1207 # static extensions with -fPIC, but links them to perl, not libperl.so
1208 # The VMS build scripts don't yet implement static extensions at all.
1210 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1211 # records of type boot_module for statically linked modules (except Dynaloader)
1212 my $static_ext = $Config{static_ext} // "";
1213 $static_ext =~ s/\//__/g;
1214 $static_ext =~ s/\bDynaLoader\b//;
1215 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1216 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1219 if ($ARGS{PLATFORM} eq 'os2') {
1220 my (%mapped, @missing);
1221 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1222 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1223 close MAP or die 'Cannot close miniperl.map';
1225 @missing = grep { !exists $mapped{$_} }
1227 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1228 delete $export{$_} foreach @missing;
1231 ###############################################################################
1233 # Now all symbols should be defined because next we are going to output them.
1235 # Start with platform specific headers:
1237 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1238 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1239 : "perl$Config{api_revision}$Config{api_version}";
1240 print "LIBRARY $dll\n";
1241 # The DESCRIPTION module definition file statement is not supported
1243 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1244 print "DESCRIPTION 'Perl interpreter'\n";
1248 elsif ($ARGS{PLATFORM} eq 'os2') {
1249 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1250 $v .= '-thread' if $Config{archname} =~ /-thread/;
1251 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1252 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1253 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1254 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1255 print <<"---EOP---";
1256 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1260 DATA LOADONCALL NONSHARED MULTIPLE
1264 elsif ($ARGS{PLATFORM} eq 'aix') {
1265 my $OSVER = `uname -v`;
1267 my $OSREL = `uname -r`;
1269 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1275 elsif ($ARGS{PLATFORM} eq 'netware') {
1276 if ($ARGS{FILETYPE} eq 'def') {
1277 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1278 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1285 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1286 foreach my $symbol (@symbols) {
1287 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1288 print "\t$symbol\n";
1290 elsif ($ARGS{PLATFORM} eq 'os2') {
1291 printf qq( %-31s \@%s\n),
1292 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1293 printf qq( %-31s \@%s\n),
1294 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1295 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1296 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1298 elsif ($ARGS{PLATFORM} eq 'netware') {
1299 print "\t$symbol,\n";
1305 # Then platform specific footers.
1307 if ($ARGS{PLATFORM} eq 'os2') {
1312 Perl_OS2_handler_install
1314 ; LAST_ORDINAL=$sym_ord