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 my @options = sort(Config::bincompat_options(), Config::non_bincompat_options());
91 print STDERR "Options: (@options)\n" unless $ARGS{PLATFORM} eq 'test';
92 $define{$_} = 1 foreach @options;
94 my %exportperlmalloc =
96 Perl_malloc => "malloc",
98 Perl_realloc => "realloc",
99 Perl_calloc => "calloc",
102 my $exportperlmalloc = $ARGS{PLATFORM} eq 'os2';
104 open(CFG, '<', 'config.h') || die "Cannot open config.h: $!\n";
106 $define{$1} = 1 if /^\s*\#\s*define\s+(MYMALLOC|MULTIPLICITY
107 |SPRINTF_RETURNS_STRLEN
108 |(?:PERL|USE|HAS)_\w+)\b/x;
112 # perl.h logic duplication begins
114 if ($define{USE_ITHREADS}) {
115 if (!$define{MULTIPLICITY}) {
116 $define{MULTIPLICITY} = 1;
120 $define{PERL_IMPLICIT_CONTEXT} ||=
121 $define{USE_ITHREADS} ||
122 $define{MULTIPLICITY} ;
124 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $^O ne 'darwin') {
125 $define{USE_REENTRANT_API} = 1;
128 # perl.h logic duplication ends
130 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
131 unless $ARGS{PLATFORM} eq 'test';
136 if ($ARGS{PLATFORM} eq 'os2') {
137 if (open my $fh, '<', 'perl5.def') {
139 last if /^\s*EXPORTS\b/;
142 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
143 # This allows skipping ordinals which were used in older versions
144 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
146 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
151 # All platforms export boot_DynaLoader unconditionally.
152 my %export = ( boot_DynaLoader => 1 );
155 foreach my $symbol (@_) {
156 ++$export{$symbol} unless exists $skip{$symbol};
161 # $hash is the hash that we're adding to. For one of our callers, it will
162 # actually be the skip hash but that doesn't affect the intent of what
163 # we're doing, as in that case we skip adding something to the skip hash
164 # for the second time.
166 my $file = $ARGS{TARG_DIR} . shift;
169 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
172 # All symbols have a Perl_ prefix because that's what embed.h sticks
173 # in front of them. The A?I?S?C? is strictly speaking wrong.
174 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
177 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
178 ++$hash->{$symbol} unless exists $skip{$var};
182 if ($ARGS{PLATFORM} ne 'os2') {
183 ++$skip{$_} foreach qw(
197 if ($ARGS{PLATFORM} eq 'vms') {
198 ++$skip{PL_statusvalue_posix};
199 # This is a wrapper if we have symlink, not a replacement
201 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
203 ++$skip{PL_statusvalue_vms};
204 if ($ARGS{PLATFORM} ne 'aix') {
205 ++$skip{$_} foreach qw(
217 if ($ARGS{PLATFORM} ne 'vms') {
218 # VMS does its own thing for these symbols.
219 ++$skip{$_} foreach qw(
220 PL_sig_handlers_initted
224 if ($ARGS{PLATFORM} ne 'win32') {
225 ++$skip{$_} foreach qw(
233 unless ($define{UNLINK_ALL_VERSIONS}) {
237 unless ($define{'DEBUGGING'}) {
238 ++$skip{$_} foreach qw(
252 if ($define{'PERL_IMPLICIT_SYS'}) {
253 ++$skip{$_} foreach qw(
257 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
258 ++$export{perl_clone_host} if $define{USE_ITHREADS};
261 ++$skip{$_} foreach qw(
276 unless ($define{'PERL_OLD_COPY_ON_WRITE'}) {
277 ++$skip{Perl_sv_setsv_cow};
280 unless ($define{'USE_REENTRANT_API'}) {
281 ++$skip{PL_reentrant_buffer};
284 if ($define{'MYMALLOC'}) {
293 unless ($define{USE_ITHREADS}) {
294 ++$skip{PL_malloc_mutex}
298 ++$skip{$_} foreach qw(
307 if ($define{'PERL_USE_SAFE_PUTENV'}) {
308 ++$skip{PL_use_safe_putenv};
311 unless ($define{'USE_ITHREADS'}) {
315 # USE_5005THREADS symbols. Kept as reference for easier removal
316 ++$skip{$_} foreach qw(
334 Perl_new_struct_thread
335 Perl_per_thread_magicals
343 unless ($define{'USE_ITHREADS'}) {
344 ++$skip{$_} foreach qw(
357 Perl_clone_params_del
358 Perl_clone_params_new
377 Perl_stashpv_hvname_match
378 Perl_regdupe_internal
383 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
384 ++$skip{$_} foreach qw(
393 Perl_load_module_nocontext
396 Perl_warner_nocontext
397 Perl_newSVpvf_nocontext
398 Perl_sv_catpvf_nocontext
399 Perl_sv_setpvf_nocontext
400 Perl_sv_catpvf_mg_nocontext
401 Perl_sv_setpvf_mg_nocontext
407 unless ($define{'PL_OP_SLAB_ALLOC'}) {
408 ++$skip{$_} foreach qw(
415 unless ($define{'PERL_DEBUG_READONLY_OPS'}) {
416 ++$skip{$_} foreach qw(
422 unless ($define{'PERL_NEED_APPCTX'}) {
426 unless ($define{'PERL_NEED_TIMESBASE'}) {
427 ++$skip{PL_timesbase};
430 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
431 ++$skip{PL_sv_serial};
434 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
435 ++$skip{PL_dumper_fd};
438 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
439 ++$skip{Perl_gv_SVadd};
442 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
443 ++$skip{Perl_my_sprintf};
446 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
447 ++$skip{PL_pidstatus};
450 unless ($define{'PERL_TRACK_MEMPOOL'}) {
451 ++$skip{PL_memory_debug_header};
454 unless ($define{PERL_MAD}) {
455 ++$skip{$_} foreach qw(
461 unless ($define{'MULTIPLICITY'}) {
462 ++$skip{$_} foreach qw(
464 PL_interp_size_5_16_0
468 unless ($define{'PERL_GLOBAL_STRUCT'}) {
469 ++$skip{PL_global_struct_size};
472 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
473 ++$skip{$_} foreach qw(
479 unless ($define{HAS_MMAP}) {
480 ++$skip{PL_mmap_page_size};
483 if ($define{HAS_SIGACTION}) {
484 ++$skip{PL_sig_trapped};
486 if ($ARGS{PLATFORM} eq 'vms') {
487 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
488 ++$skip{PL_sig_ignoring};
492 unless ($define{USE_LOCALE_COLLATE}) {
493 ++$skip{$_} foreach qw(
496 PL_collation_standard
500 Perl_sv_collxfrm_flags
504 unless ($define{USE_LOCALE_NUMERIC}) {
505 ++$skip{$_} foreach qw(
513 unless ($define{HAVE_INTERP_INTERN}) {
514 ++$skip{$_} foreach qw(
515 Perl_sys_intern_clear
522 if ($define{HAS_SIGNBIT}) {
523 ++$skip{Perl_signbit};
526 if ($define{'PERL_GLOBAL_STRUCT'}) {
527 readvar('perlvars.h', \%skip);
528 # This seems like the least ugly way to cope with the fact that PL_sh_path
529 # is mentioned in perlvar.h and globvar.sym, and always exported.
530 delete $skip{PL_sh_path};
531 ++$export{Perl_GetVars};
532 try_symbols(qw(PL_Vars PL_VarsPtr)) unless $ARGS{CCTYPE} eq 'GCC';
534 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
537 # functions from *.sym files
539 my @syms = qw(globvar.sym);
541 # Symbols that are the public face of the PerlIO layers implementation
542 # These are in _addition to_ the public face of the abstraction
543 # and need to be exported to allow XS modules to implement layers
558 PerlIOBase_setlinebuf
597 Perl_PerlIO_context_layers
604 Perl_PerlIO_get_bufsiz
610 Perl_PerlIO_set_ptrcnt
611 Perl_PerlIO_setlinebuf
619 if ($ARGS{PLATFORM} eq 'netware') {
620 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
623 if ($define{'USE_PERLIO'}) {
624 # Export the symols that make up the PerlIO abstraction, regardless
625 # of its implementation - read from a file
626 push @syms, 'perlio.sym';
628 # This part is then dependent on how the abstraction is implemented
629 if ($define{'USE_SFIO'}) {
630 # Old legacy non-stdio "PerlIO"
631 ++$skip{$_} foreach @layer_syms;
632 ++$skip{perlsio_binmode};
633 # SFIO defines most of the PerlIO routines as macros
634 # So undo most of what $perlio_sym has just done - d'oh !
635 # Perhaps it would be better to list the ones which do exist
637 ++$skip{$_} foreach qw(
688 Perl_PerlIO_get_bufsiz
694 Perl_PerlIO_set_ptrcnt
695 Perl_PerlIO_setlinebuf
708 # PerlIO with layers - export implementation
709 try_symbols(@layer_syms, 'perlsio_binmode');
713 # Skip the PerlIO layer symbols - although
714 # nothing should have exported them anyway.
715 ++$skip{$_} foreach @layer_syms;
716 ++$skip{$_} foreach qw(
723 PL_perlio_fd_refcnt_size
727 # Also do NOT add abstraction symbols from $perlio_sym
728 # abstraction is done as #define to stdio
729 # Remaining remnants that _may_ be functions are handled below.
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});
742 my ($flags, $retval, $func, @args) = @$_;
744 if ($flags =~ /[AX]/ && $flags !~ /[xm]/ || $flags =~ /b/) {
745 # public API, so export
747 # If a function is defined twice, for example before and after
748 # an #else, only export its name once. Important to do this test
749 # within the block, as the *first* definition may have flags which
750 # mean "don't export"
751 next if $seen{$func}++;
752 $func = "Perl_$func" if $flags =~ /[pbX]/;
753 ++$export{$func} unless exists $skip{$func};
759 my $syms = $ARGS{TARG_DIR} . $_;
760 open my $global, '<', $syms or die "failed to open $syms: $!\n";
761 # Functions already have a Perl_ prefix
762 # Variables need a PL_ prefix
763 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
765 next unless /^([A-Za-z].*)/;
766 my $symbol = "$prefix$1";
767 ++$export{$symbol} unless exists $skip{$symbol};
773 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
774 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
775 # XXX AIX seems to want the perlvars.h symbols, for some reason
776 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
777 readvar('perlvars.h', \%export);
781 unless ($define{'PERL_GLOBAL_STRUCT'}) {
782 readvar('perlvars.h', \%export);
784 unless ($define{MULTIPLICITY}) {
785 readvar('intrpvar.h', \%export);
789 # Oddities from PerlIO
790 # All have alternate implementations in perlio.c, so always exist.
791 # Should they be considered to be part of the API?
802 if ($ARGS{PLATFORM} eq 'win32') {
814 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
875 win32_getprotobynumber
971 elsif ($ARGS{PLATFORM} eq 'vms') {
976 Perl_csighandler_init
979 Perl_fileify_dirspec_ts
980 Perl_fileify_dirspec_utf8
981 Perl_fileify_dirspec_utf8_ts
1013 Perl_pathify_dirspec
1014 Perl_pathify_dirspec_ts
1015 Perl_pathify_dirspec_utf8
1016 Perl_pathify_dirspec_utf8_ts
1024 Perl_rmsexpand_utf8_ts
1026 Perl_sig_to_vmscondition
1030 Perl_tounixpath_utf8
1031 Perl_tounixpath_utf8_ts
1034 Perl_tounixspec_utf8
1035 Perl_tounixspec_utf8_ts
1039 Perl_tovmspath_utf8_ts
1043 Perl_tovmsspec_utf8_ts
1045 Perl_vms_case_tolerant
1056 elsif ($ARGS{PLATFORM} eq 'os2') {
1099 XS_Cwd_current_drive
1101 XS_Cwd_extLibpath_set
1105 XS_Cwd_sys_is_absolute
1106 XS_Cwd_sys_is_relative
1107 XS_Cwd_sys_is_rooted
1108 XS_DynaLoader_mod2fname
1109 XS_File__Copy_syscopy
1113 Perl_Process_Messages
1125 elsif ($ARGS{PLATFORM} eq 'netware') {
1252 fnInsertHashListAddrs
1264 # When added this code was only run for Win32 and WinCE
1265 # Currently only Win32 links static extensions into the shared library.
1266 # The WinCE makefile doesn't appear to support static extensions, so this code
1267 # can't have any effect there.
1268 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1269 # list of dynamic extensions, and the rules to build them)
1270 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1271 # static extensions with -fPIC, but links them to perl, not libperl.so
1272 # The VMS build scripts don't yet implement static extensions at all.
1274 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1275 # records of type boot_module for statically linked modules (except Dynaloader)
1276 my $static_ext = $Config{static_ext} // "";
1277 $static_ext =~ s/\//__/g;
1278 $static_ext =~ s/\bDynaLoader\b//;
1279 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1280 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1283 if ($ARGS{PLATFORM} eq 'os2') {
1284 my (%mapped, @missing);
1285 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1286 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1287 close MAP or die 'Cannot close miniperl.map';
1289 @missing = grep { !exists $mapped{$_} }
1291 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1292 delete $export{$_} foreach @missing;
1295 ###############################################################################
1297 # Now all symbols should be defined because next we are going to output them.
1299 # Start with platform specific headers:
1301 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1302 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1303 : "perl$Config{api_revision}$Config{api_version}";
1304 print "LIBRARY $dll\n";
1305 # The DESCRIPTION module definition file statement is not supported
1307 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1308 print "DESCRIPTION 'Perl interpreter'\n";
1312 elsif ($ARGS{PLATFORM} eq 'os2') {
1313 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1314 $v .= '-thread' if $Config{archname} =~ /-thread/;
1315 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1316 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1317 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1318 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1319 print <<"---EOP---";
1320 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1324 DATA LOADONCALL NONSHARED MULTIPLE
1328 elsif ($ARGS{PLATFORM} eq 'aix') {
1329 my $OSVER = `uname -v`;
1331 my $OSREL = `uname -r`;
1333 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1339 elsif ($ARGS{PLATFORM} eq 'netware') {
1340 if ($ARGS{FILETYPE} eq 'def') {
1341 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1342 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1349 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1350 foreach my $symbol (@symbols) {
1351 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1352 print "\t$symbol\n";
1354 elsif ($ARGS{PLATFORM} eq 'os2') {
1355 printf qq( %-31s \@%s\n),
1356 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1357 printf qq( %-31s \@%s\n),
1358 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1359 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1360 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1362 elsif ($ARGS{PLATFORM} eq 'netware') {
1363 print "\t$symbol,\n";
1369 # Then platform specific footers.
1371 if ($ARGS{PLATFORM} eq 'os2') {
1376 Perl_OS2_handler_install
1378 ; LAST_ORDINAL=$sym_ord