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
109 |(?:PERL|USE|HAS)_\w+)\b/x;
113 # perl.h logic duplication begins
115 if ($define{USE_ITHREADS}) {
116 if (!$define{MULTIPLICITY}) {
117 $define{MULTIPLICITY} = 1;
121 $define{PERL_IMPLICIT_CONTEXT} ||=
122 $define{USE_ITHREADS} ||
123 $define{MULTIPLICITY} ;
125 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $^O ne 'darwin') {
126 $define{USE_REENTRANT_API} = 1;
129 # perl.h logic duplication ends
131 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
132 unless $ARGS{PLATFORM} eq 'test';
137 if ($ARGS{PLATFORM} eq 'os2') {
138 if (open my $fh, '<', 'perl5.def') {
140 last if /^\s*EXPORTS\b/;
143 $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
144 # This allows skipping ordinals which were used in older versions
145 $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
147 $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
152 # All platforms export boot_DynaLoader unconditionally.
153 my %export = ( boot_DynaLoader => 1 );
156 foreach my $symbol (@_) {
157 ++$export{$symbol} unless exists $skip{$symbol};
162 # $hash is the hash that we're adding to. For one of our callers, it will
163 # actually be the skip hash but that doesn't affect the intent of what
164 # we're doing, as in that case we skip adding something to the skip hash
165 # for the second time.
167 my $file = $ARGS{TARG_DIR} . shift;
170 open my $vars, '<', $file or die die "Cannot open $file: $!\n";
173 # All symbols have a Perl_ prefix because that's what embed.h sticks
174 # in front of them. The A?I?S?C? is strictly speaking wrong.
175 next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
178 my $symbol = $proc ? &$proc($1,$2,$3) : $var;
179 ++$hash->{$symbol} unless exists $skip{$var};
183 if ($ARGS{PLATFORM} ne 'os2') {
184 ++$skip{$_} foreach qw(
198 if ($ARGS{PLATFORM} eq 'vms') {
199 ++$skip{PL_statusvalue_posix};
200 # This is a wrapper if we have symlink, not a replacement
202 ++$skip{Perl_my_symlink} unless $Config{d_symlink};
204 ++$skip{PL_statusvalue_vms};
205 if ($ARGS{PLATFORM} ne 'aix') {
206 ++$skip{$_} foreach qw(
218 if ($ARGS{PLATFORM} ne 'vms') {
219 # VMS does its own thing for these symbols.
220 ++$skip{$_} foreach qw(
221 PL_sig_handlers_initted
225 if ($ARGS{PLATFORM} ne 'win32') {
226 ++$skip{$_} foreach qw(
234 unless ($define{UNLINK_ALL_VERSIONS}) {
238 unless ($define{'DEBUGGING'}) {
239 ++$skip{$_} foreach qw(
253 if ($define{'PERL_IMPLICIT_SYS'}) {
254 ++$skip{$_} foreach qw(
258 ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
259 ++$export{perl_clone_host} if $define{USE_ITHREADS};
262 ++$skip{$_} foreach qw(
277 unless ($define{'PERL_OLD_COPY_ON_WRITE'}
278 || $define{'PERL_NEW_COPY_ON_WRITE'}) {
279 ++$skip{Perl_sv_setsv_cow};
282 unless ($define{PERL_SAW_AMPERSAND}) {
283 ++$skip{PL_sawampersand};
286 unless ($define{'USE_REENTRANT_API'}) {
287 ++$skip{PL_reentrant_buffer};
290 if ($define{'MYMALLOC'}) {
299 unless ($define{USE_ITHREADS}) {
300 ++$skip{PL_malloc_mutex}
304 ++$skip{$_} foreach qw(
313 if ($define{'PERL_USE_SAFE_PUTENV'}) {
314 ++$skip{PL_use_safe_putenv};
317 unless ($define{'USE_ITHREADS'}) {
321 # USE_5005THREADS symbols. Kept as reference for easier removal
322 ++$skip{$_} foreach qw(
340 Perl_new_struct_thread
341 Perl_per_thread_magicals
349 unless ($define{'USE_ITHREADS'}) {
350 ++$skip{$_} foreach qw(
363 Perl_clone_params_del
364 Perl_clone_params_new
383 Perl_stashpv_hvname_match
384 Perl_regdupe_internal
389 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
390 ++$skip{$_} foreach qw(
399 Perl_load_module_nocontext
402 Perl_warner_nocontext
403 Perl_newSVpvf_nocontext
404 Perl_sv_catpvf_nocontext
405 Perl_sv_setpvf_nocontext
406 Perl_sv_catpvf_mg_nocontext
407 Perl_sv_setpvf_mg_nocontext
413 unless ($define{'PERL_NEED_APPCTX'}) {
417 unless ($define{'PERL_NEED_TIMESBASE'}) {
418 ++$skip{PL_timesbase};
421 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
422 ++$skip{PL_sv_serial};
425 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
426 ++$skip{PL_dumper_fd};
429 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
430 ++$skip{Perl_gv_SVadd};
433 if ($define{'SPRINTF_RETURNS_STRLEN'}) {
434 ++$skip{Perl_my_sprintf};
437 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
438 ++$skip{PL_pidstatus};
441 unless ($define{'PERL_TRACK_MEMPOOL'}) {
442 ++$skip{PL_memory_debug_header};
445 unless ($define{PERL_MAD}) {
446 ++$skip{$_} foreach qw(
452 unless ($define{'MULTIPLICITY'}) {
453 ++$skip{$_} foreach qw(
455 PL_interp_size_5_16_0
459 unless ($define{'PERL_GLOBAL_STRUCT'}) {
460 ++$skip{PL_global_struct_size};
463 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
464 ++$skip{$_} foreach qw(
470 unless ($define{HAS_MMAP}) {
471 ++$skip{PL_mmap_page_size};
474 if ($define{HAS_SIGACTION}) {
475 ++$skip{PL_sig_trapped};
477 if ($ARGS{PLATFORM} eq 'vms') {
478 # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
479 ++$skip{PL_sig_ignoring};
480 ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
484 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
485 # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
486 ++$skip{Perl_csighandler_init};
487 ++$skip{Perl_my_kill};
488 ++$skip{Perl_sig_to_vmscondition};
489 ++$skip{PL_sig_defaulting};
490 ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
493 unless ($define{USE_LOCALE_COLLATE}) {
494 ++$skip{$_} foreach qw(
497 PL_collation_standard
501 Perl_sv_collxfrm_flags
505 unless ($define{USE_LOCALE_NUMERIC}) {
506 ++$skip{$_} foreach qw(
514 unless ($define{HAVE_INTERP_INTERN}) {
515 ++$skip{$_} foreach qw(
516 Perl_sys_intern_clear
523 if ($define{HAS_SIGNBIT}) {
524 ++$skip{Perl_signbit};
527 if ($define{'PERL_GLOBAL_STRUCT'}) {
528 readvar('perlvars.h', \%skip);
529 # This seems like the least ugly way to cope with the fact that PL_sh_path
530 # is mentioned in perlvar.h and globvar.sym, and always exported.
531 delete $skip{PL_sh_path};
532 ++$export{Perl_GetVars};
533 try_symbols(qw(PL_Vars PL_VarsPtr)) unless $ARGS{CCTYPE} eq 'GCC';
535 ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
538 # functions from *.sym files
540 my @syms = qw(globvar.sym);
542 # Symbols that are the public face of the PerlIO layers implementation
543 # These are in _addition to_ the public face of the abstraction
544 # and need to be exported to allow XS modules to implement layers
559 PerlIOBase_setlinebuf
598 Perl_PerlIO_context_layers
605 Perl_PerlIO_get_bufsiz
611 Perl_PerlIO_set_ptrcnt
612 Perl_PerlIO_setlinebuf
620 if ($ARGS{PLATFORM} eq 'netware') {
621 push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
624 if ($define{'USE_PERLIO'}) {
625 # Export the symols that make up the PerlIO abstraction, regardless
626 # of its implementation - read from a file
627 push @syms, 'perlio.sym';
629 # This part is then dependent on how the abstraction is implemented
630 if ($define{'USE_SFIO'}) {
631 # Old legacy non-stdio "PerlIO"
632 ++$skip{$_} foreach @layer_syms;
633 ++$skip{perlsio_binmode};
634 # SFIO defines most of the PerlIO routines as macros
635 # So undo most of what $perlio_sym has just done - d'oh !
636 # Perhaps it would be better to list the ones which do exist
638 ++$skip{$_} foreach qw(
689 Perl_PerlIO_get_bufsiz
695 Perl_PerlIO_set_ptrcnt
696 Perl_PerlIO_setlinebuf
709 # PerlIO with layers - export implementation
710 try_symbols(@layer_syms, 'perlsio_binmode');
714 # Skip the PerlIO layer symbols - although
715 # nothing should have exported them anyway.
716 ++$skip{$_} foreach @layer_syms;
717 ++$skip{$_} foreach qw(
724 PL_perlio_fd_refcnt_size
728 # Also do NOT add abstraction symbols from $perlio_sym
729 # abstraction is done as #define to stdio
730 # Remaining remnants that _may_ be functions are handled below.
733 ###############################################################################
735 # At this point all skip lists should be completed, as we are about to test
736 # many symbols against them.
740 my ($embed) = setup_embed($ARGS{TARG_DIR});
743 my ($flags, $retval, $func, @args) = @$_;
745 if ($flags =~ /[AX]/ && $flags !~ /[xm]/ || $flags =~ /b/) {
746 # public API, so export
748 # If a function is defined twice, for example before and after
749 # an #else, only export its name once. Important to do this test
750 # within the block, as the *first* definition may have flags which
751 # mean "don't export"
752 next if $seen{$func}++;
753 $func = "Perl_$func" if $flags =~ /[pbX]/;
754 ++$export{$func} unless exists $skip{$func};
760 my $syms = $ARGS{TARG_DIR} . $_;
761 open my $global, '<', $syms or die "failed to open $syms: $!\n";
762 # Functions already have a Perl_ prefix
763 # Variables need a PL_ prefix
764 my $prefix = $syms =~ /var\.sym$/i ? 'PL_' : '';
766 next unless /^([A-Za-z].*)/;
767 my $symbol = "$prefix$1";
768 ++$export{$symbol} unless exists $skip{$symbol};
774 if ($define{'MULTIPLICITY'} && $define{PERL_GLOBAL_STRUCT}) {
775 readvar('perlvars.h', \%export, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
776 # XXX AIX seems to want the perlvars.h symbols, for some reason
777 if ($ARGS{PLATFORM} eq 'aix' or $ARGS{PLATFORM} eq 'os2') { # OS/2 needs PL_thr_key
778 readvar('perlvars.h', \%export);
782 unless ($define{'PERL_GLOBAL_STRUCT'}) {
783 readvar('perlvars.h', \%export);
785 unless ($define{MULTIPLICITY}) {
786 readvar('intrpvar.h', \%export);
790 # Oddities from PerlIO
791 # All have alternate implementations in perlio.c, so always exist.
792 # Should they be considered to be part of the API?
803 if ($ARGS{PLATFORM} eq 'win32') {
813 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
874 win32_getprotobynumber
970 elsif ($ARGS{PLATFORM} eq 'vms') {
975 Perl_csighandler_init
978 Perl_fileify_dirspec_ts
979 Perl_fileify_dirspec_utf8
980 Perl_fileify_dirspec_utf8_ts
1012 Perl_pathify_dirspec
1013 Perl_pathify_dirspec_ts
1014 Perl_pathify_dirspec_utf8
1015 Perl_pathify_dirspec_utf8_ts
1023 Perl_rmsexpand_utf8_ts
1025 Perl_sig_to_vmscondition
1029 Perl_tounixpath_utf8
1030 Perl_tounixpath_utf8_ts
1033 Perl_tounixspec_utf8
1034 Perl_tounixspec_utf8_ts
1038 Perl_tovmspath_utf8_ts
1042 Perl_tovmsspec_utf8_ts
1044 Perl_vms_case_tolerant
1055 elsif ($ARGS{PLATFORM} eq 'os2') {
1098 XS_Cwd_current_drive
1100 XS_Cwd_extLibpath_set
1104 XS_Cwd_sys_is_absolute
1105 XS_Cwd_sys_is_relative
1106 XS_Cwd_sys_is_rooted
1107 XS_DynaLoader_mod2fname
1108 XS_File__Copy_syscopy
1112 Perl_Process_Messages
1124 elsif ($ARGS{PLATFORM} eq 'netware') {
1251 fnInsertHashListAddrs
1263 # When added this code was only run for Win32 and WinCE
1264 # Currently only Win32 links static extensions into the shared library.
1265 # The WinCE makefile doesn't appear to support static extensions, so this code
1266 # can't have any effect there.
1267 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1268 # list of dynamic extensions, and the rules to build them)
1269 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1270 # static extensions with -fPIC, but links them to perl, not libperl.so
1271 # The VMS build scripts don't yet implement static extensions at all.
1273 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1274 # records of type boot_module for statically linked modules (except Dynaloader)
1275 my $static_ext = $Config{static_ext} // "";
1276 $static_ext =~ s/\//__/g;
1277 $static_ext =~ s/\bDynaLoader\b//;
1278 try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1279 try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1282 if ($ARGS{PLATFORM} eq 'os2') {
1283 my (%mapped, @missing);
1284 open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
1285 /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1286 close MAP or die 'Cannot close miniperl.map';
1288 @missing = grep { !exists $mapped{$_} }
1290 @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1291 delete $export{$_} foreach @missing;
1294 ###############################################################################
1296 # Now all symbols should be defined because next we are going to output them.
1298 # Start with platform specific headers:
1300 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1301 my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1302 : "perl$Config{api_revision}$Config{api_version}";
1303 print "LIBRARY $dll\n";
1304 # The DESCRIPTION module definition file statement is not supported
1306 if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1307 print "DESCRIPTION 'Perl interpreter'\n";
1311 elsif ($ARGS{PLATFORM} eq 'os2') {
1312 (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1313 $v .= '-thread' if $Config{archname} =~ /-thread/;
1314 (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1315 $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1316 my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1317 $d = substr($d, 0, 249) . "...'" if length $d > 253;
1318 print <<"---EOP---";
1319 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1323 DATA LOADONCALL NONSHARED MULTIPLE
1327 elsif ($ARGS{PLATFORM} eq 'aix') {
1328 my $OSVER = `uname -v`;
1330 my $OSREL = `uname -r`;
1332 if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1338 elsif ($ARGS{PLATFORM} eq 'netware') {
1339 if ($ARGS{FILETYPE} eq 'def') {
1340 print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1341 print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1348 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1349 foreach my $symbol (@symbols) {
1350 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1351 print "\t$symbol\n";
1353 elsif ($ARGS{PLATFORM} eq 'os2') {
1354 printf qq( %-31s \@%s\n),
1355 qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1356 printf qq( %-31s \@%s\n),
1357 qq("$exportperlmalloc{$symbol}" = "$symbol"),
1358 $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1359 if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1361 elsif ($ARGS{PLATFORM} eq 'netware') {
1362 print "\t$symbol,\n";
1368 # Then platform specific footers.
1370 if ($ARGS{PLATFORM} eq 'os2') {
1375 Perl_OS2_handler_install
1377 ; LAST_ORDINAL=$sym_ord