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{'PERL_NEED_APPCTX'}) {
411 unless ($define{'PERL_NEED_TIMESBASE'}) {
412 ++$skip{PL_timesbase};
415 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
416 ++$skip{PL_sv_serial};
419 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
420 ++$skip{PL_dumper_fd};
423 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
424 ++$skip{Perl_gv_SVadd};
427 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
428 ++$skip{Perl_my_sprintf};
431 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
432 ++$skip{PL_pidstatus};
435 unless ($define{'PERL_TRACK_MEMPOOL'}) {
436 ++$skip{PL_memory_debug_header};
439 unless ($define{PERL_MAD}) {
440 ++$skip{$_} foreach qw(
446 unless ($define{'MULTIPLICITY'}) {
447 ++$skip{$_} foreach qw(
449 PL_interp_size_5_16_0
453 unless ($define{'PERL_GLOBAL_STRUCT'}) {
454 ++$skip{PL_global_struct_size};
457 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
458 ++$skip{$_} foreach qw(
464 unless ($define{HAS_MMAP}) {
465 ++$skip{PL_mmap_page_size};
468 if ($define{HAS_SIGACTION}) {
469 ++$skip{PL_sig_trapped};
471 if ($ARGS{PLATFORM} eq 'vms') {
472 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
473 ++$skip{PL_sig_ignoring};
477 unless ($define{USE_LOCALE_COLLATE}) {
478 ++$skip{$_} foreach qw(
481 PL_collation_standard
485 Perl_sv_collxfrm_flags
489 unless ($define{USE_LOCALE_NUMERIC}) {
490 ++$skip{$_} foreach qw(
498 unless ($define{HAVE_INTERP_INTERN}) {
499 ++$skip{$_} foreach qw(
500 Perl_sys_intern_clear
507 if ($define{HAS_SIGNBIT}) {
508 ++$skip{Perl_signbit};
511 if ($define{'PERL_GLOBAL_STRUCT'}) {
512 readvar('perlvars.h', \%skip);
513 # This seems like the least ugly way to cope with the fact that PL_sh_path
514 # is mentioned in perlvar.h and globvar.sym, and always exported.
515 delete $skip{PL_sh_path};
516 ++$export{Perl_GetVars};
517 try_symbols(qw(PL_Vars PL_VarsPtr)) unless $ARGS{CCTYPE} eq 'GCC';
519 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
522 # functions from *.sym files
524 my @syms = qw(globvar.sym);
526 # Symbols that are the public face of the PerlIO layers implementation
527 # These are in _addition to_ the public face of the abstraction
528 # and need to be exported to allow XS modules to implement layers
543 PerlIOBase_setlinebuf
582 Perl_PerlIO_context_layers
589 Perl_PerlIO_get_bufsiz
595 Perl_PerlIO_set_ptrcnt
596 Perl_PerlIO_setlinebuf
604 if ($ARGS{PLATFORM} eq 'netware') {
605 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
608 if ($define{'USE_PERLIO'}) {
609 # Export the symols that make up the PerlIO abstraction, regardless
610 # of its implementation - read from a file
611 push @syms, 'perlio.sym';
613 # This part is then dependent on how the abstraction is implemented
614 if ($define{'USE_SFIO'}) {
615 # Old legacy non-stdio "PerlIO"
616 ++$skip{$_} foreach @layer_syms;
617 ++$skip{perlsio_binmode};
618 # SFIO defines most of the PerlIO routines as macros
619 # So undo most of what $perlio_sym has just done - d'oh !
620 # Perhaps it would be better to list the ones which do exist
622 ++$skip{$_} foreach qw(
673 Perl_PerlIO_get_bufsiz
679 Perl_PerlIO_set_ptrcnt
680 Perl_PerlIO_setlinebuf
693 # PerlIO with layers - export implementation
694 try_symbols(@layer_syms, 'perlsio_binmode');
698 # Skip the PerlIO layer symbols - although
699 # nothing should have exported them anyway.
700 ++$skip{$_} foreach @layer_syms;
701 ++$skip{$_} foreach qw(
708 PL_perlio_fd_refcnt_size
712 # Also do NOT add abstraction symbols from $perlio_sym
713 # abstraction is done as #define to stdio
714 # Remaining remnants that _may_ be functions are handled below.
717 ###############################################################################
719 # At this point all skip lists should be completed, as we are about to test
720 # many symbols against them.
724 my ($embed) = setup_embed($ARGS{TARG_DIR});
727 my ($flags, $retval, $func, @args) = @$_;
729 if ($flags =~ /[AX]/ && $flags !~ /[xm]/ || $flags =~ /b/) {
730 # public API, so export
732 # If a function is defined twice, for example before and after
733 # an #else, only export its name once. Important to do this test
734 # within the block, as the *first* definition may have flags which
735 # mean "don't export"
736 next if $seen{$func}++;
737 $func = "Perl_$func" if $flags =~ /[pbX]/;
738 ++$export{$func} unless exists $skip{$func};
744 my $syms = $ARGS{TARG_DIR} . $_;
745 open my $global, '<', $syms or die "failed to open $syms: $!\n";
746 # Functions already have a Perl_ prefix
747 # Variables need a PL_ prefix
748 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
750 next unless /^([A-Za-z].*)/;
751 my $symbol = "$prefix$1";
752 ++$export{$symbol} unless exists $skip{$symbol};
758 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
759 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
760 # XXX AIX seems to want the perlvars.h symbols, for some reason
761 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
762 readvar('perlvars.h', \%export);
766 unless ($define{'PERL_GLOBAL_STRUCT'}) {
767 readvar('perlvars.h', \%export);
769 unless ($define{MULTIPLICITY}) {
770 readvar('intrpvar.h', \%export);
774 # Oddities from PerlIO
775 # All have alternate implementations in perlio.c, so always exist.
776 # Should they be considered to be part of the API?
787 if ($ARGS{PLATFORM} eq 'win32') {
799 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
860 win32_getprotobynumber
956 elsif ($ARGS{PLATFORM} eq 'vms') {
961 Perl_csighandler_init
964 Perl_fileify_dirspec_ts
965 Perl_fileify_dirspec_utf8
966 Perl_fileify_dirspec_utf8_ts
999 Perl_pathify_dirspec_ts
1000 Perl_pathify_dirspec_utf8
1001 Perl_pathify_dirspec_utf8_ts
1009 Perl_rmsexpand_utf8_ts
1011 Perl_sig_to_vmscondition
1015 Perl_tounixpath_utf8
1016 Perl_tounixpath_utf8_ts
1019 Perl_tounixspec_utf8
1020 Perl_tounixspec_utf8_ts
1024 Perl_tovmspath_utf8_ts
1028 Perl_tovmsspec_utf8_ts
1030 Perl_vms_case_tolerant
1041 elsif ($ARGS{PLATFORM} eq 'os2') {
1084 XS_Cwd_current_drive
1086 XS_Cwd_extLibpath_set
1090 XS_Cwd_sys_is_absolute
1091 XS_Cwd_sys_is_relative
1092 XS_Cwd_sys_is_rooted
1093 XS_DynaLoader_mod2fname
1094 XS_File__Copy_syscopy
1098 Perl_Process_Messages
1110 elsif ($ARGS{PLATFORM} eq 'netware') {
1237 fnInsertHashListAddrs
1249 # When added this code was only run for Win32 and WinCE
1250 # Currently only Win32 links static extensions into the shared library.
1251 # The WinCE makefile doesn't appear to support static extensions, so this code
1252 # can't have any effect there.
1253 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1254 # list of dynamic extensions, and the rules to build them)
1255 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1256 # static extensions with -fPIC, but links them to perl, not libperl.so
1257 # The VMS build scripts don't yet implement static extensions at all.
1259 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1260 # records of type boot_module for statically linked modules (except Dynaloader)
1261 my $static_ext = $Config{static_ext} // "";
1262 $static_ext =~ s/\//__/g;
1263 $static_ext =~ s/\bDynaLoader\b//;
1264 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1265 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1268 if ($ARGS{PLATFORM} eq 'os2') {
1269 my (%mapped, @missing);
1270 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1271 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1272 close MAP or die 'Cannot close miniperl.map';
1274 @missing = grep { !exists $mapped{$_} }
1276 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1277 delete $export{$_} foreach @missing;
1280 ###############################################################################
1282 # Now all symbols should be defined because next we are going to output them.
1284 # Start with platform specific headers:
1286 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1287 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1288 : "perl$Config{api_revision}$Config{api_version}";
1289 print "LIBRARY $dll\n";
1290 # The DESCRIPTION module definition file statement is not supported
1292 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1293 print "DESCRIPTION 'Perl interpreter'\n";
1297 elsif ($ARGS{PLATFORM} eq 'os2') {
1298 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1299 $v .= '-thread' if $Config{archname} =~ /-thread/;
1300 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1301 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1302 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1303 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1304 print <<"---EOP---";
1305 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1309 DATA LOADONCALL NONSHARED MULTIPLE
1313 elsif ($ARGS{PLATFORM} eq 'aix') {
1314 my $OSVER = `uname -v`;
1316 my $OSREL = `uname -r`;
1318 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1324 elsif ($ARGS{PLATFORM} eq 'netware') {
1325 if ($ARGS{FILETYPE} eq 'def') {
1326 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1327 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1334 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1335 foreach my $symbol (@symbols) {
1336 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1337 print "\t$symbol\n";
1339 elsif ($ARGS{PLATFORM} eq 'os2') {
1340 printf qq( %-31s \@%s\n),
1341 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1342 printf qq( %-31s \@%s\n),
1343 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1344 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1345 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1347 elsif ($ARGS{PLATFORM} eq 'netware') {
1348 print "\t$symbol,\n";
1354 # Then platform specific footers.
1356 if ($ARGS{PLATFORM} eq 'os2') {
1361 Perl_OS2_handler_install
1363 ; LAST_ORDINAL=$sym_ord