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 = $ARGS{PLATFORM} eq 'wince' ? 'xconfig.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 unless ($define{UNLINK_ALL_VERSIONS}) {
242 unless ($define{'DEBUGGING'}) {
243 ++$skip{$_} foreach qw(
257 if ($define{'PERL_IMPLICIT_SYS'}) {
258 ++$skip{$_} foreach qw(
262 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
263 ++$export{perl_clone_host} if $define{USE_ITHREADS};
266 ++$skip{$_} foreach qw(
281 unless ($define{'PERL_OLD_COPY_ON_WRITE'}
282 || $define{'PERL_NEW_COPY_ON_WRITE'}) {
283 ++$skip{Perl_sv_setsv_cow};
286 unless ($define{PERL_SAWAMPERSAND}) {
287 ++$skip{PL_sawampersand};
290 unless ($define{'USE_REENTRANT_API'}) {
291 ++$skip{PL_reentrant_buffer};
294 if ($define{'MYMALLOC'}) {
303 unless ($define{USE_ITHREADS}) {
304 ++$skip{PL_malloc_mutex}
308 ++$skip{$_} foreach qw(
317 if ($define{'PERL_USE_SAFE_PUTENV'}) {
318 ++$skip{PL_use_safe_putenv};
321 unless ($define{'USE_ITHREADS'}) {
325 # USE_5005THREADS symbols. Kept as reference for easier removal
326 ++$skip{$_} foreach qw(
344 Perl_new_struct_thread
345 Perl_per_thread_magicals
353 unless ($define{'USE_ITHREADS'}) {
354 ++$skip{$_} foreach qw(
368 Perl_clone_params_del
369 Perl_clone_params_new
388 Perl_stashpv_hvname_match
389 Perl_regdupe_internal
394 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
395 ++$skip{$_} foreach qw(
404 Perl_load_module_nocontext
407 Perl_warner_nocontext
408 Perl_newSVpvf_nocontext
409 Perl_sv_catpvf_nocontext
410 Perl_sv_setpvf_nocontext
411 Perl_sv_catpvf_mg_nocontext
412 Perl_sv_setpvf_mg_nocontext
418 unless ($define{'PERL_NEED_APPCTX'}) {
422 unless ($define{'PERL_NEED_TIMESBASE'}) {
423 ++$skip{PL_timesbase};
426 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
427 ++$skip{PL_sv_serial};
430 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
431 ++$skip{PL_dumper_fd};
434 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
435 ++$skip{Perl_gv_SVadd};
438 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
439 ++$skip{Perl_my_sprintf};
442 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
443 ++$skip{PL_pidstatus};
446 unless ($define{'PERL_TRACK_MEMPOOL'}) {
447 ++$skip{PL_memory_debug_header};
450 unless ($define{PERL_MAD}) {
451 ++$skip{$_} foreach qw(
457 unless ($define{'MULTIPLICITY'}) {
458 ++$skip{$_} foreach qw(
460 PL_interp_size_5_18_0
464 unless ($define{'PERL_GLOBAL_STRUCT'}) {
465 ++$skip{PL_global_struct_size};
468 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
469 ++$skip{$_} foreach qw(
475 unless ($define{HAS_MMAP}) {
476 ++$skip{PL_mmap_page_size};
479 if ($define{HAS_SIGACTION}) {
480 ++$skip{PL_sig_trapped};
482 if ($ARGS{PLATFORM} eq 'vms') {
483 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
484 ++$skip{PL_sig_ignoring};
485 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
489 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
490 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
491 ++$skip{Perl_csighandler_init};
492 ++$skip{Perl_my_kill};
493 ++$skip{Perl_sig_to_vmscondition};
494 ++$skip{PL_sig_defaulting};
495 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
498 unless ($define{USE_LOCALE_COLLATE}) {
499 ++$skip{$_} foreach qw(
502 PL_collation_standard
506 Perl_sv_collxfrm_flags
510 unless ($define{USE_LOCALE_NUMERIC}) {
511 ++$skip{$_} foreach qw(
519 unless ($define{HAVE_INTERP_INTERN}) {
520 ++$skip{$_} foreach qw(
521 Perl_sys_intern_clear
528 if ($define{HAS_SIGNBIT}) {
529 ++$skip{Perl_signbit};
532 if ($define{'PERL_GLOBAL_STRUCT'}) {
533 readvar('perlvars.h', \%skip);
534 # This seems like the least ugly way to cope with the fact that PL_sh_path
535 # is mentioned in perlvar.h and globvar.sym, and always exported.
536 delete $skip{PL_sh_path};
537 ++$export{Perl_GetVars};
538 try_symbols(qw(PL_Vars PL_VarsPtr))
539 unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
541 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
544 ++$skip{PL_op_exec_cnt}
545 unless $define{PERL_TRACE_OPS};
547 # functions from *.sym files
549 my @syms = qw(globvar.sym);
551 # Symbols that are the public face of the PerlIO layers implementation
552 # These are in _addition to_ the public face of the abstraction
553 # and need to be exported to allow XS modules to implement layers
568 PerlIOBase_setlinebuf
607 Perl_PerlIO_context_layers
614 Perl_PerlIO_get_bufsiz
620 Perl_PerlIO_set_ptrcnt
621 Perl_PerlIO_setlinebuf
629 if ($ARGS{PLATFORM} eq 'netware') {
630 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
633 if ($define{'USE_PERLIO'}) {
634 # Export the symbols that make up the PerlIO abstraction, regardless
635 # of its implementation - read from a file
636 push @syms, 'perlio.sym';
638 # This part is then dependent on how the abstraction is implemented
639 if ($define{'USE_SFIO'}) {
640 # Old legacy non-stdio "PerlIO"
641 ++$skip{$_} foreach @layer_syms;
642 ++$skip{perlsio_binmode};
643 # SFIO defines most of the PerlIO routines as macros
644 # So undo most of what $perlio_sym has just done - d'oh !
645 # Perhaps it would be better to list the ones which do exist
647 ++$skip{$_} foreach qw(
698 Perl_PerlIO_get_bufsiz
704 Perl_PerlIO_set_ptrcnt
705 Perl_PerlIO_setlinebuf
718 # PerlIO with layers - export implementation
719 try_symbols(@layer_syms, 'perlsio_binmode');
723 # Skip the PerlIO layer symbols - although
724 # nothing should have exported them anyway.
725 ++$skip{$_} foreach @layer_syms;
726 ++$skip{$_} foreach qw(
733 PL_perlio_fd_refcnt_size
737 # Also do NOT add abstraction symbols from $perlio_sym
738 # abstraction is done as #define to stdio
739 # Remaining remnants that _may_ be functions are handled below.
742 ###############################################################################
744 # At this point all skip lists should be completed, as we are about to test
745 # many symbols against them.
749 my ($embed) = setup_embed($ARGS{TARG_DIR});
752 my ($flags, $retval, $func, @args) = @$_;
754 if ($flags =~ /[AX]/ && $flags !~ /[xmi]/ || $flags =~ /b/) {
755 # public API, so export
757 # If a function is defined twice, for example before and after
758 # an #else, only export its name once. Important to do this test
759 # within the block, as the *first* definition may have flags which
760 # mean "don't export"
761 next if $seen{$func}++;
762 # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
763 $func = "Perl_$func" if ($flags =~ /[pbX]/ && $func !~ /^Perl_/);
764 ++$export{$func} unless exists $skip{$func};
770 my $syms = $ARGS{TARG_DIR} . $_;
771 open my $global, '<', $syms or die "failed to open $syms: $!\n";
772 # Functions already have a Perl_ prefix
773 # Variables need a PL_ prefix
774 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
776 next unless /^([A-Za-z].*)/;
777 my $symbol = "$prefix$1";
778 ++$export{$symbol} unless exists $skip{$symbol};
784 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
785 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
786 # XXX AIX seems to want the perlvars.h symbols, for some reason
787 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
788 readvar('perlvars.h', \%export);
792 unless ($define{'PERL_GLOBAL_STRUCT'}) {
793 readvar('perlvars.h', \%export);
795 unless ($define{MULTIPLICITY}) {
796 readvar('intrpvar.h', \%export);
800 # Oddities from PerlIO
801 # All have alternate implementations in perlio.c, so always exist.
802 # Should they be considered to be part of the API?
813 if ($ARGS{PLATFORM} eq 'win32') {
823 if ($ARGS{PLATFORM} eq 'wince') {
824 ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
827 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
888 win32_getprotobynumber
984 elsif ($ARGS{PLATFORM} eq 'vms') {
989 Perl_csighandler_init
992 Perl_fileify_dirspec_ts
993 Perl_fileify_dirspec_utf8
994 Perl_fileify_dirspec_utf8_ts
1026 Perl_pathify_dirspec
1027 Perl_pathify_dirspec_ts
1028 Perl_pathify_dirspec_utf8
1029 Perl_pathify_dirspec_utf8_ts
1037 Perl_rmsexpand_utf8_ts
1039 Perl_sig_to_vmscondition
1043 Perl_tounixpath_utf8
1044 Perl_tounixpath_utf8_ts
1047 Perl_tounixspec_utf8
1048 Perl_tounixspec_utf8_ts
1052 Perl_tovmspath_utf8_ts
1056 Perl_tovmsspec_utf8_ts
1058 Perl_vms_case_tolerant
1069 elsif ($ARGS{PLATFORM} eq 'os2') {
1112 XS_Cwd_current_drive
1114 XS_Cwd_extLibpath_set
1118 XS_Cwd_sys_is_absolute
1119 XS_Cwd_sys_is_relative
1120 XS_Cwd_sys_is_rooted
1121 XS_DynaLoader_mod2fname
1122 XS_File__Copy_syscopy
1126 Perl_Process_Messages
1138 elsif ($ARGS{PLATFORM} eq 'netware') {
1265 fnInsertHashListAddrs
1277 # When added this code was only run for Win32 and WinCE
1278 # Currently only Win32 links static extensions into the shared library.
1279 # The WinCE makefile doesn't appear to support static extensions, so this code
1280 # can't have any effect there.
1281 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1282 # list of dynamic extensions, and the rules to build them)
1283 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1284 # static extensions with -fPIC, but links them to perl, not libperl.so
1285 # The VMS build scripts don't yet implement static extensions at all.
1287 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1288 # records of type boot_module for statically linked modules (except Dynaloader)
1289 my $static_ext = $Config{static_ext} // "";
1290 $static_ext =~ s/\//__/g;
1291 $static_ext =~ s/\bDynaLoader\b//;
1292 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1293 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1296 if ($ARGS{PLATFORM} eq 'os2') {
1297 my (%mapped, @missing);
1298 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1299 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1300 close MAP or die 'Cannot close miniperl.map';
1302 @missing = grep { !exists $mapped{$_} }
1304 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1305 delete $export{$_} foreach @missing;
1308 ###############################################################################
1310 # Now all symbols should be defined because next we are going to output them.
1312 # Start with platform specific headers:
1314 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1315 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1316 : "perl$Config{api_revision}$Config{api_version}";
1317 print "LIBRARY $dll\n";
1318 # The DESCRIPTION module definition file statement is not supported
1320 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1321 print "DESCRIPTION 'Perl interpreter'\n";
1325 elsif ($ARGS{PLATFORM} eq 'os2') {
1326 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1327 $v .= '-thread' if $Config{archname} =~ /-thread/;
1328 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1329 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1330 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1331 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1332 print <<"---EOP---";
1333 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1337 DATA LOADONCALL NONSHARED MULTIPLE
1341 elsif ($ARGS{PLATFORM} eq 'aix') {
1342 my $OSVER = `uname -v`;
1344 my $OSREL = `uname -r`;
1346 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1352 elsif ($ARGS{PLATFORM} eq 'netware') {
1353 if ($ARGS{FILETYPE} eq 'def') {
1354 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1355 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1362 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1363 foreach my $symbol (@symbols) {
1364 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1365 print "\t$symbol\n";
1367 elsif ($ARGS{PLATFORM} eq 'os2') {
1368 printf qq( %-31s \@%s\n),
1369 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1370 printf qq( %-31s \@%s\n),
1371 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1372 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1373 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1375 elsif ($ARGS{PLATFORM} eq 'netware') {
1376 print "\t$symbol,\n";
1382 # Then platform specific footers.
1384 if ($ARGS{PLATFORM} eq 'os2') {
1389 Perl_OS2_handler_install
1391 ; LAST_ORDINAL=$sym_ord