handy.h: Add some comments
[perl.git] / makedef.pl
1 #./perl -w
2 #
3 # Create the export list for perl.
4 #
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.
8 #
9 # Reads from information stored in
10 #
11 #    %Config::Config (ie config.sh)
12 #    config.h
13 #    embed.fnc
14 #    globvar.sym
15 #    intrpvar.h
16 #    miniperl.map (on OS/2)
17 #    perl5.def    (on OS/2; this is the old version of the file being made)
18 #    perlio.sym
19 #    perlvars.h
20 #    regen/opcodes
21 #
22 # plus long lists of function names hard-coded directly in this script.
23 #
24 # Writes the result to STDOUT.
25 #
26 # Normally this script is invoked from a makefile (e.g. win32/Makefile),
27 # which redirects STDOUT to a suitable file, such as:
28 #
29 #    perl5.def   OS/2
30 #    perldll.def Windows
31 #    perl.exp    AIX
32 #    perl.imp    NetWare
33 #    makedef.lis VMS
34
35 my $fold;
36 my %ARGS;
37 my %define;
38
39 BEGIN {
40     BEGIN { unshift @INC, "lib" }
41     use Config;
42     use strict;
43
44     %ARGS = (CCTYPE => 'MSVC', TARG_DIR => '');
45
46     sub process_cc_flags {
47         foreach (map {split /\s+/, $_} @_) {
48             $define{$1} = $2 // 1 if /^-D(\w+)(?:=(.+))?/;
49         }
50     }
51
52     while (@ARGV) {
53         my $flag = shift;
54         if ($flag =~ /^(?:CC_FLAGS=)?(-D\w.*)/) {
55             process_cc_flags($1);
56         } elsif ($flag =~ /^(CCTYPE|FILETYPE|PLATFORM|TARG_DIR)=(.+)$/) {
57             $ARGS{$1} = $2;
58         } elsif ($flag eq '--sort-fold') {
59             ++$fold;
60         }
61     }
62     my @PLATFORM = qw(aix win32 wince os2 netware vms test);
63     my %PLATFORM;
64     @PLATFORM{@PLATFORM} = ();
65
66     die "PLATFORM undefined, must be one of: @PLATFORM\n"
67         unless defined $ARGS{PLATFORM};
68     die "PLATFORM must be one of: @PLATFORM\n"
69         unless exists $PLATFORM{$ARGS{PLATFORM}};
70 }
71 use constant PLATFORM => $ARGS{PLATFORM};
72
73 require "./$ARGS{TARG_DIR}regen/embed_lib.pl";
74
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';
80
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.
89
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;
95 }
96
97 my %exportperlmalloc =
98     (
99        Perl_malloc              =>      "malloc",
100        Perl_mfree               =>      "free",
101        Perl_realloc             =>      "realloc",
102        Perl_calloc              =>      "calloc",
103     );
104
105 my $exportperlmalloc = $ARGS{PLATFORM} eq 'os2';
106
107 my $config_h = 'config.h';
108 open(CFG, '<', $config_h) || die "Cannot open $config_h: $!\n";
109 while (<CFG>) {
110     $define{$1} = 1 if /^\s*\#\s*define\s+(MYMALLOC|MULTIPLICITY
111                                            |KILL_BY_SIGPRC
112                                            |(?:PERL|USE|HAS)_\w+)\b/x;
113 }
114 close(CFG);
115
116 # perl.h logic duplication begins
117
118 if ($define{USE_ITHREADS}) {
119     if (!$define{MULTIPLICITY}) {
120         $define{MULTIPLICITY} = 1;
121     }
122 }
123
124 $define{PERL_IMPLICIT_CONTEXT} ||=
125     $define{USE_ITHREADS} ||
126     $define{MULTIPLICITY} ;
127
128 if ($define{USE_ITHREADS} && $ARGS{PLATFORM} ne 'win32' && $ARGS{PLATFORM} ne 'netware') {
129     $define{USE_REENTRANT_API} = 1;
130 }
131
132 if (     $define{USE_ITHREADS}
133     &&   $define{HAS_SETLOCALE}
134     && ! $define{NO_LOCALE}
135     && ! $define{NO_POSIX_2008_LOCALE})
136 {
137     $define{HAS_POSIX_2008_LOCALE} = 1 if $define{HAS_NEWLOCALE}
138                                        && $define{HAS_FREELOCALE}
139                                        && $define{HAS_USELOCALE};
140     my $cctype = $ARGS{CCTYPE} =~ s/MSVC//r;
141     if (    ! $define{NO_THREAD_SAFE_LOCALE}
142         && (  $define{HAS_POSIX_2008_LOCALE}
143             || ($ARGS{PLATFORM} eq 'win32' && (   $cctype !~ /\D/
144                                                && $cctype >= 80))))
145     {
146         $define{USE_THREAD_SAFE_LOCALE} = 1;
147         $define{USE_POSIX_2008_LOCALE} = 1 if $define{HAS_POSIX_2008_LOCALE};
148     }
149
150     if (   $ARGS{PLATFORM} eq 'win32'
151         && $define{USE_THREAD_SAFE_LOCALE}
152         && $cctype < 140)
153     {
154         $define{TS_W32_BROKEN_LOCALECONV} = 1;
155     }
156 }
157
158 # perl.h logic duplication ends
159
160 print STDERR "Defines: (" . join(' ', sort keys %define) . ")\n"
161      unless $ARGS{PLATFORM} eq 'test';
162
163 my $sym_ord = 0;
164 my %ordinal;
165
166 if ($ARGS{PLATFORM} eq 'os2') {
167     if (open my $fh, '<', 'perl5.def') {
168       while (<$fh>) {
169         last if /^\s*EXPORTS\b/;
170       }
171       while (<$fh>) {
172         $ordinal{$1} = $2 if /^\s*"(\w+)"\s*(?:=\s*"\w+"\s*)?\@(\d+)\s*$/;
173         # This allows skipping ordinals which were used in older versions
174         $sym_ord = $1 if /^\s*;\s*LAST_ORDINAL\s*=\s*(\d+)\s*$/;
175       }
176       $sym_ord < $_ and $sym_ord = $_ for values %ordinal; # Take the max
177     }
178 }
179
180 my %skip;
181 # All platforms export boot_DynaLoader unconditionally.
182 my %export = ( boot_DynaLoader => 1 );
183
184 sub try_symbols {
185     foreach my $symbol (@_) {
186         ++$export{$symbol} unless exists $skip{$symbol};
187     }
188 }
189
190 sub readvar {
191     # $hash is the hash that we're adding to. For one of our callers, it will
192     # actually be the skip hash but that doesn't affect the intent of what
193     # we're doing, as in that case we skip adding something to the skip hash
194     # for the second time.
195
196     my $file = $ARGS{TARG_DIR} . shift;
197     my $hash = shift;
198     my $proc = shift;
199     open my $vars, '<', $file or die die "Cannot open $file: $!\n";
200
201     while (<$vars>) {
202         # All symbols have a Perl_ prefix because that's what embed.h sticks
203         # in front of them.  The A?I?S?C? is strictly speaking wrong.
204         next unless /\bPERLVAR(A?I?S?C?)\(([IGT]),\s*(\w+)/;
205
206         my $var = "PL_$3";
207         my $symbol = $proc ? &$proc($1,$2,$3) : $var;
208         ++$hash->{$symbol} unless exists $skip{$var};
209     }
210 }
211
212 if ($ARGS{PLATFORM} ne 'os2') {
213     ++$skip{$_} foreach qw(
214                      PL_cryptseen
215                      PL_opsave
216                      Perl_GetVars
217                      Perl_dump_fds
218                      Perl_my_bcopy
219                      Perl_my_bzero
220                      Perl_my_chsize
221                      Perl_my_htonl
222                      Perl_my_memcmp
223                      Perl_my_memset
224                      Perl_my_ntohl
225                      Perl_my_swap
226                          );
227     if ($ARGS{PLATFORM} eq 'vms') {
228         ++$skip{PL_statusvalue_posix};
229         # This is a wrapper if we have symlink, not a replacement
230         # if we don't.
231         ++$skip{Perl_my_symlink} unless $Config{d_symlink};
232     } else {
233         ++$skip{PL_statusvalue_vms};
234         ++$skip{PL_perllib_sep};
235         if ($ARGS{PLATFORM} ne 'aix') {
236             ++$skip{$_} foreach qw(
237                                 PL_DBcv
238                                 PL_generation
239                                 PL_lastgotoprobe
240                                 PL_modcount
241                                 main
242                                  );
243         }
244     }
245 }
246
247 if ($ARGS{PLATFORM} ne 'vms') {
248     # VMS does its own thing for these symbols.
249     ++$skip{$_} foreach qw(
250                         PL_sig_handlers_initted
251                         PL_sig_ignoring
252                         PL_sig_defaulting
253                          );
254     if ($ARGS{PLATFORM} ne 'win32') {
255         ++$skip{$_} foreach qw(
256                             Perl_do_spawn
257                             Perl_do_spawn_nowait
258                             Perl_do_aspawn
259                              );
260     }
261 }
262
263 if ($ARGS{PLATFORM} ne 'win32') {
264     ++$skip{$_} foreach qw(
265                     Perl_my_setlocale
266                          );
267 }
268
269 unless ($define{UNLINK_ALL_VERSIONS}) {
270     ++$skip{Perl_unlnk};
271 }
272
273 unless ($define{'DEBUGGING'}) {
274     ++$skip{$_} foreach qw(
275                     Perl_debop
276                     Perl_debprofdump
277                     Perl_debstack
278                     Perl_debstackptrs
279                     Perl_pad_sv
280                     Perl_pad_setsv
281                     Perl__setlocale_debug_string
282                     Perl_set_padlist
283                     Perl_hv_assert
284                     PL_watchaddr
285                     PL_watchok
286                     PL_watch_pvx
287                          );
288 }
289
290 if ($define{'PERL_IMPLICIT_SYS'}) {
291     ++$skip{$_} foreach qw(
292                     Perl_my_popen
293                     Perl_my_pclose
294                          );
295     ++$export{$_} foreach qw(perl_get_host_info perl_alloc_override);
296     ++$export{perl_clone_host} if $define{USE_ITHREADS};
297 }
298 else {
299     ++$skip{$_} foreach qw(
300                     PL_Mem
301                     PL_MemShared
302                     PL_MemParse
303                     PL_Env
304                     PL_StdIO
305                     PL_LIO
306                     PL_Dir
307                     PL_Sock
308                     PL_Proc
309                     perl_alloc_using
310                     perl_clone_using
311                          );
312 }
313
314 if (!$define{'PERL_COPY_ON_WRITE'} || $define{'PERL_NO_COW'}) {
315     ++$skip{Perl_sv_setsv_cow};
316 }
317
318 unless ($define{PERL_SAWAMPERSAND}) {
319     ++$skip{PL_sawampersand};
320 }
321
322 unless ($define{'USE_REENTRANT_API'}) {
323     ++$skip{PL_reentrant_buffer};
324 }
325
326 if ($define{'MYMALLOC'}) {
327     try_symbols(qw(
328                     Perl_dump_mstats
329                     Perl_get_mstats
330                     Perl_strdup
331                     Perl_putenv
332                     MallocCfg_ptr
333                     MallocCfgP_ptr
334                     ));
335     unless ($define{USE_ITHREADS}) {
336         ++$skip{PL_malloc_mutex}
337     }
338 }
339 else {
340     ++$skip{$_} foreach qw(
341                     PL_malloc_mutex
342                     Perl_dump_mstats
343                     Perl_get_mstats
344                     MallocCfg_ptr
345                     MallocCfgP_ptr
346                          );
347 }
348
349 if ($define{'PERL_USE_SAFE_PUTENV'}) {
350     ++$skip{PL_use_safe_putenv};
351 }
352
353 unless ($define{'USE_ITHREADS'}) {
354     ++$skip{PL_thr_key};
355 }
356
357 # USE_5005THREADS symbols. Kept as reference for easier removal
358 ++$skip{$_} foreach qw(
359                     PL_sv_mutex
360                     PL_strtab_mutex
361                     PL_svref_mutex
362                     PL_cred_mutex
363                     PL_eval_mutex
364                     PL_fdpid_mutex
365                     PL_sv_lock_mutex
366                     PL_eval_cond
367                     PL_eval_owner
368                     PL_threads_mutex
369                     PL_nthreads
370                     PL_nthreads_cond
371                     PL_threadnum
372                     PL_threadsv_names
373                     PL_thrsv
374                     PL_vtbl_mutex
375                     Perl_condpair_magic
376                     Perl_new_struct_thread
377                     Perl_per_thread_magicals
378                     Perl_thread_create
379                     Perl_find_threadsv
380                     Perl_unlock_condpair
381                     Perl_magic_mutexfree
382                     Perl_sv_lock
383                      );
384
385 unless ($define{'USE_ITHREADS'}) {
386     ++$skip{$_} foreach qw(
387                     PL_keyword_plugin_mutex
388                     PL_check_mutex
389                     PL_curlocales
390                     PL_op_mutex
391                     PL_regex_pad
392                     PL_regex_padav
393                     PL_dollarzero_mutex
394                     PL_hints_mutex
395                     PL_locale_mutex
396                     PL_lc_numeric_mutex
397                     PL_lc_numeric_mutex_depth
398                     PL_my_ctx_mutex
399                     PL_perlio_mutex
400                     PL_stashpad
401                     PL_stashpadix
402                     PL_stashpadmax
403                     Perl_alloccopstash
404                     Perl_allocfilegv
405                     Perl_clone_params_del
406                     Perl_clone_params_new
407                     Perl_parser_dup
408                     Perl_dirp_dup
409                     Perl_cx_dup
410                     Perl_si_dup
411                     Perl_any_dup
412                     Perl_ss_dup
413                     Perl_fp_dup
414                     Perl_gp_dup
415                     Perl_he_dup
416                     Perl_mg_dup
417                     Perl_re_dup_guts
418                     Perl_sv_dup
419                     Perl_sv_dup_inc
420                     Perl_rvpv_dup
421                     Perl_hek_dup
422                     Perl_sys_intern_dup
423                     perl_clone
424                     perl_clone_using
425                     Perl_stashpv_hvname_match
426                     Perl_regdupe_internal
427                     Perl_newPADOP
428                     PL_C_locale_obj
429                          );
430 }
431
432 unless ( $define{'HAS_NEWLOCALE'}
433     &&   $define{'HAS_FREELOCALE'}
434     &&   $define{'HAS_USELOCALE'}
435     && ! $define{'NO_POSIX_2008_LOCALE'})
436 {
437     ++$skip{$_} foreach qw(
438         PL_C_locale_obj
439         PL_underlying_numeric_obj
440     );
441 }
442
443 unless ($define{'PERL_IMPLICIT_CONTEXT'}) {
444     ++$skip{$_} foreach qw(
445                     PL_my_cxt_index
446                     PL_my_cxt_list
447                     PL_my_cxt_size
448                     PL_my_cxt_keys
449                     Perl_croak_nocontext
450                     Perl_die_nocontext
451                     Perl_deb_nocontext
452                     Perl_form_nocontext
453                     Perl_load_module_nocontext
454                     Perl_mess_nocontext
455                     Perl_warn_nocontext
456                     Perl_warner_nocontext
457                     Perl_newSVpvf_nocontext
458                     Perl_sv_catpvf_nocontext
459                     Perl_sv_setpvf_nocontext
460                     Perl_sv_catpvf_mg_nocontext
461                     Perl_sv_setpvf_mg_nocontext
462                     Perl_my_cxt_init
463                     Perl_my_cxt_index
464                          );
465 }
466
467 if ($define{USE_THREAD_SAFE_LOCALE}) {
468     ++$skip{PL_lc_numeric_mutex};
469     ++$skip{PL_lc_numeric_mutex_depth};
470     if (! $define{TS_W32_BROKEN_LOCALECONV}) {
471         ++$skip{PL_locale_mutex};
472     }
473 }
474
475 unless ($define{'PERL_OP_PARENT'}) {
476     ++$skip{$_} foreach qw(
477                     Perl_op_parent
478                 );
479 }
480
481 unless ($define{'USE_DTRACE'}) {
482     ++$skip{$_} foreach qw(
483                     Perl_dtrace_probe_call
484                     Perl_dtrace_probe_load
485                     Perl_dtrace_probe_op
486                     Perl_dtrace_probe_phase
487                 );
488 }
489
490 unless ($define{'PERL_NEED_APPCTX'}) {
491     ++$skip{PL_appctx};
492 }
493
494 unless ($define{'PERL_NEED_TIMESBASE'}) {
495     ++$skip{PL_timesbase};
496 }
497
498 unless ($define{'DEBUG_LEAKING_SCALARS'}) {
499     ++$skip{PL_sv_serial};
500 }
501
502 unless ($define{'DEBUG_LEAKING_SCALARS_FORK_DUMP'}) {
503     ++$skip{PL_dumper_fd};
504 }
505
506 unless ($define{'PERL_DONT_CREATE_GVSV'}) {
507     ++$skip{Perl_gv_SVadd};
508 }
509
510 unless ($define{'PERL_USES_PL_PIDSTATUS'}) {
511     ++$skip{PL_pidstatus};
512 }
513
514 unless ($define{'PERL_TRACK_MEMPOOL'}) {
515     ++$skip{PL_memory_debug_header};
516 }
517
518 unless ($define{'MULTIPLICITY'}) {
519     ++$skip{$_} foreach qw(
520                     PL_interp_size
521                     PL_interp_size_5_18_0
522                     PL_sv_yes
523                     PL_sv_undef
524                     PL_sv_no
525                     PL_sv_zero
526                          );
527 }
528
529 unless ($define{'PERL_GLOBAL_STRUCT'}) {
530     ++$skip{PL_global_struct_size};
531 }
532
533 unless ($define{'PERL_GLOBAL_STRUCT_PRIVATE'}) {
534     ++$skip{$_} foreach qw(
535                     PL_my_cxt_keys
536                     Perl_my_cxt_index
537                          );
538 }
539
540 unless ($define{HAS_MMAP}) {
541     ++$skip{PL_mmap_page_size};
542 }
543
544 if ($define{HAS_SIGACTION}) {
545     ++$skip{PL_sig_trapped};
546
547     if ($ARGS{PLATFORM} eq 'vms') {
548         # FAKE_PERSISTENT_SIGNAL_HANDLERS defined as !defined(HAS_SIGACTION)
549         ++$skip{PL_sig_ignoring};
550         ++$skip{PL_sig_handlers_initted} unless $define{KILL_BY_SIGPRC};
551     }
552 }
553
554 if ($ARGS{PLATFORM} eq 'vms' && !$define{KILL_BY_SIGPRC}) {
555     # FAKE_DEFAULT_SIGNAL_HANDLERS defined as KILL_BY_SIGPRC
556     ++$skip{Perl_csighandler_init};
557     ++$skip{Perl_my_kill};
558     ++$skip{Perl_sig_to_vmscondition};
559     ++$skip{PL_sig_defaulting};
560     ++$skip{PL_sig_handlers_initted} unless !$define{HAS_SIGACTION};
561 }
562
563 if ($define{'HAS_STRNLEN'})
564 {
565     ++$skip{Perl_my_strnlen};
566 }
567
568 unless ($define{USE_LOCALE_COLLATE}) {
569     ++$skip{$_} foreach qw(
570                     PL_collation_ix
571                     PL_collation_name
572                     PL_collation_standard
573                     PL_collxfrm_base
574                     PL_collxfrm_mult
575                     Perl_sv_collxfrm
576                     Perl_sv_collxfrm_flags
577                     PL_strxfrm_NUL_replacement
578                     PL_strxfrm_is_behaved
579                     PL_strxfrm_max_cp
580                          );
581 }
582
583 unless ($define{USE_LOCALE_NUMERIC}) {
584     ++$skip{$_} foreach qw(
585                     PL_numeric_local
586                     PL_numeric_name
587                     PL_numeric_radix_sv
588                     PL_numeric_standard
589                     PL_numeric_underlying
590                     PL_numeric_underlying_is_standard
591                     PL_underlying_numeric_obj
592                          );
593 }
594
595 unless ($define{'USE_C_BACKTRACE'}) {
596     ++$skip{Perl_get_c_backtrace_dump};
597     ++$skip{Perl_dump_c_backtrace};
598 }
599
600 unless ($define{HAVE_INTERP_INTERN}) {
601     ++$skip{$_} foreach qw(
602                     Perl_sys_intern_clear
603                     Perl_sys_intern_dup
604                     Perl_sys_intern_init
605                     PL_sys_intern
606                          );
607 }
608
609 if ($define{HAS_SIGNBIT}) {
610     ++$skip{Perl_signbit};
611 }
612
613 if ($define{'PERL_GLOBAL_STRUCT'}) {
614     readvar('perlvars.h', \%skip);
615     # This seems like the least ugly way to cope with the fact that PL_sh_path
616     # is mentioned in perlvar.h and globvar.sym, and always exported.
617     delete $skip{PL_sh_path};
618     ++$export{Perl_GetVars};
619     try_symbols(qw(PL_Vars PL_VarsPtr))
620       unless $ARGS{CCTYPE} eq 'GCC' || $define{PERL_GLOBAL_STRUCT_PRIVATE};
621 } else {
622     ++$skip{$_} foreach qw(Perl_init_global_struct Perl_free_global_struct);
623 }
624
625 ++$skip{PL_op_exec_cnt}
626     unless $define{PERL_TRACE_OPS};
627
628 ++$skip{PL_hash_chars}
629     unless $define{PERL_USE_SINGLE_CHAR_HASH_CACHE};
630
631 # functions from *.sym files
632
633 my @syms = qw(globvar.sym);
634
635 # Symbols that are the public face of the PerlIO layers implementation
636 # These are in _addition to_ the public face of the abstraction
637 # and need to be exported to allow XS modules to implement layers
638 my @layer_syms = qw(
639                     PerlIOBase_binmode
640                     PerlIOBase_clearerr
641                     PerlIOBase_close
642                     PerlIOBase_dup
643                     PerlIOBase_eof
644                     PerlIOBase_error
645                     PerlIOBase_fileno
646                     PerlIOBase_open
647                     PerlIOBase_noop_fail
648                     PerlIOBase_noop_ok
649                     PerlIOBase_popped
650                     PerlIOBase_pushed
651                     PerlIOBase_read
652                     PerlIOBase_setlinebuf
653                     PerlIOBase_unread
654                     PerlIOBuf_bufsiz
655                     PerlIOBuf_close
656                     PerlIOBuf_dup
657                     PerlIOBuf_fill
658                     PerlIOBuf_flush
659                     PerlIOBuf_get_base
660                     PerlIOBuf_get_cnt
661                     PerlIOBuf_get_ptr
662                     PerlIOBuf_open
663                     PerlIOBuf_popped
664                     PerlIOBuf_pushed
665                     PerlIOBuf_read
666                     PerlIOBuf_seek
667                     PerlIOBuf_set_ptrcnt
668                     PerlIOBuf_tell
669                     PerlIOBuf_unread
670                     PerlIOBuf_write
671                     PerlIO_allocate
672                     PerlIO_apply_layera
673                     PerlIO_apply_layers
674                     PerlIO_arg_fetch
675                     PerlIO_debug
676                     PerlIO_define_layer
677                     PerlIO_find_layer
678                     PerlIO_isutf8
679                     PerlIO_layer_fetch
680                     PerlIO_list_alloc
681                     PerlIO_list_free
682                     PerlIO_modestr
683                     PerlIO_parse_layers
684                     PerlIO_pending
685                     PerlIO_perlio
686                     PerlIO_pop
687                     PerlIO_push
688                     PerlIO_sv_dup
689                     Perl_PerlIO_clearerr
690                     Perl_PerlIO_close
691                     Perl_PerlIO_context_layers
692                     Perl_PerlIO_eof
693                     Perl_PerlIO_error
694                     Perl_PerlIO_fileno
695                     Perl_PerlIO_fill
696                     Perl_PerlIO_flush
697                     Perl_PerlIO_get_base
698                     Perl_PerlIO_get_bufsiz
699                     Perl_PerlIO_get_cnt
700                     Perl_PerlIO_get_ptr
701                     Perl_PerlIO_read
702                     Perl_PerlIO_restore_errno
703                     Perl_PerlIO_save_errno
704                     Perl_PerlIO_seek
705                     Perl_PerlIO_set_cnt
706                     Perl_PerlIO_set_ptrcnt
707                     Perl_PerlIO_setlinebuf
708                     Perl_PerlIO_stderr
709                     Perl_PerlIO_stdin
710                     Perl_PerlIO_stdout
711                     Perl_PerlIO_tell
712                     Perl_PerlIO_unread
713                     Perl_PerlIO_write
714 );
715 if ($ARGS{PLATFORM} eq 'netware') {
716     push(@layer_syms,'PL_def_layerlist','PL_known_layers','PL_perlio');
717 }
718
719 # Export the symbols that make up the PerlIO abstraction, regardless
720 # of its implementation - read from a file
721 push @syms, 'perlio.sym';
722
723 # PerlIO with layers - export implementation
724 try_symbols(@layer_syms, 'perlsio_binmode');
725
726
727 unless ($define{'USE_QUADMATH'}) {
728   ++$skip{Perl_quadmath_format_needed};
729   ++$skip{Perl_quadmath_format_single};
730 }
731
732 ###############################################################################
733
734 # At this point all skip lists should be completed, as we are about to test
735 # many symbols against them.
736
737 {
738     my %seen;
739     my ($embed) = setup_embed($ARGS{TARG_DIR});
740     my $excludedre = $define{'NO_MATHOMS'} ? qr/[xmib]/ : qr/[xmi]/;
741
742     foreach (@$embed) {
743         my ($flags, $retval, $func, @args) = @$_;
744         next unless $func;
745         if (($flags =~ /[AX]/ && $flags !~ $excludedre)
746             || (!$define{'NO_MATHOMS'} && $flags =~ /b/))
747         {
748             # public API, so export
749
750             # If a function is defined twice, for example before and after
751             # an #else, only export its name once. Important to do this test
752             # within the block, as the *first* definition may have flags which
753             # mean "don't export"
754             next if $seen{$func}++;
755             # Should we also skip adding the Perl_ prefix if $flags =~ /o/ ?
756             $func = "Perl_$func" if ($flags =~ /[pX]/ && $func !~ /^Perl_/);
757             ++$export{$func} unless exists $skip{$func};
758         }
759     }
760 }
761
762 foreach (@syms) {
763     my $syms = $ARGS{TARG_DIR} . $_;
764     open my $global, '<', $syms or die "failed to open $syms: $!\n";
765     while (<$global>) {
766         next unless /^([A-Za-z].*)/;
767         my $symbol = "$1";
768         ++$export{$symbol} unless exists $skip{$symbol};
769     }
770 }
771
772 # variables
773
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);
779     }
780 }
781 else {
782     unless ($define{'PERL_GLOBAL_STRUCT'}) {
783         readvar('perlvars.h', \%export);
784     }
785     unless ($define{MULTIPLICITY}) {
786         readvar('intrpvar.h', \%export);
787     }
788 }
789
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?
793 try_symbols(qw(
794                     PerlIO_binmode
795                     PerlIO_getpos
796                     PerlIO_init
797                     PerlIO_setpos
798                     PerlIO_tmpfile
799              ));
800
801 if ($ARGS{PLATFORM} eq 'win32') {
802     try_symbols(qw(
803                                  win32_free_childdir
804                                  win32_free_childenv
805                                  win32_get_childdir
806                                  win32_get_childenv
807                                  win32_spawnvp
808                  ));
809 }
810
811 if ($ARGS{PLATFORM} eq 'wince') {
812     ++$skip{'win32_isatty'}; # commit 4342f4d6df is win32-only
813 }
814
815 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
816     try_symbols(qw(
817                             Perl_init_os_extras
818                             Perl_thread_create
819                             Perl_win32_init
820                             Perl_win32_term
821                             RunPerl
822                             win32_async_check
823                             win32_errno
824                             win32_environ
825                             win32_abort
826                             win32_fstat
827                             win32_stat
828                             win32_pipe
829                             win32_popen
830                             win32_pclose
831                             win32_rename
832                             win32_setmode
833                             win32_chsize
834                             win32_lseek
835                             win32_tell
836                             win32_dup
837                             win32_dup2
838                             win32_open
839                             win32_close
840                             win32_eof
841                             win32_isatty
842                             win32_read
843                             win32_write
844                             win32_mkdir
845                             win32_rmdir
846                             win32_chdir
847                             win32_flock
848                             win32_execv
849                             win32_execvp
850                             win32_htons
851                             win32_ntohs
852                             win32_htonl
853                             win32_ntohl
854                             win32_inet_addr
855                             win32_inet_ntoa
856                             win32_socket
857                             win32_bind
858                             win32_listen
859                             win32_accept
860                             win32_connect
861                             win32_send
862                             win32_sendto
863                             win32_recv
864                             win32_recvfrom
865                             win32_shutdown
866                             win32_closesocket
867                             win32_ioctlsocket
868                             win32_setsockopt
869                             win32_getsockopt
870                             win32_getpeername
871                             win32_getsockname
872                             win32_gethostname
873                             win32_gethostbyname
874                             win32_gethostbyaddr
875                             win32_getprotobyname
876                             win32_getprotobynumber
877                             win32_getservbyname
878                             win32_getservbyport
879                             win32_select
880                             win32_endhostent
881                             win32_endnetent
882                             win32_endprotoent
883                             win32_endservent
884                             win32_getnetent
885                             win32_getnetbyname
886                             win32_getnetbyaddr
887                             win32_getprotoent
888                             win32_getservent
889                             win32_sethostent
890                             win32_setnetent
891                             win32_setprotoent
892                             win32_setservent
893                             win32_getenv
894                             win32_putenv
895                             win32_perror
896                             win32_malloc
897                             win32_calloc
898                             win32_realloc
899                             win32_free
900                             win32_sleep
901                             win32_pause
902                             win32_times
903                             win32_access
904                             win32_alarm
905                             win32_chmod
906                             win32_open_osfhandle
907                             win32_get_osfhandle
908                             win32_ioctl
909                             win32_link
910                             win32_unlink
911                             win32_utime
912                             win32_gettimeofday
913                             win32_uname
914                             win32_wait
915                             win32_waitpid
916                             win32_kill
917                             win32_str_os_error
918                             win32_opendir
919                             win32_readdir
920                             win32_telldir
921                             win32_seekdir
922                             win32_rewinddir
923                             win32_closedir
924                             win32_longpath
925                             win32_ansipath
926                             win32_os_id
927                             win32_getpid
928                             win32_crypt
929                             win32_dynaload
930                             win32_clearenv
931                             win32_stdin
932                             win32_stdout
933                             win32_stderr
934                             win32_ferror
935                             win32_feof
936                             win32_strerror
937                             win32_fprintf
938                             win32_printf
939                             win32_vfprintf
940                             win32_vprintf
941                             win32_fread
942                             win32_fwrite
943                             win32_fopen
944                             win32_fdopen
945                             win32_freopen
946                             win32_fclose
947                             win32_fputs
948                             win32_fputc
949                             win32_ungetc
950                             win32_getc
951                             win32_fileno
952                             win32_clearerr
953                             win32_fflush
954                             win32_ftell
955                             win32_fseek
956                             win32_fgetpos
957                             win32_fsetpos
958                             win32_rewind
959                             win32_tmpfile
960                             win32_setbuf
961                             win32_setvbuf
962                             win32_flushall
963                             win32_fcloseall
964                             win32_fgets
965                             win32_gets
966                             win32_fgetc
967                             win32_putc
968                             win32_puts
969                             win32_getchar
970                             win32_putchar
971                  ));
972 }
973 elsif ($ARGS{PLATFORM} eq 'vms') {
974     try_symbols(qw(
975                       Perl_cando
976                       Perl_cando_by_name
977                       Perl_closedir
978                       Perl_csighandler_init
979                       Perl_do_rmdir
980                       Perl_fileify_dirspec
981                       Perl_fileify_dirspec_ts
982                       Perl_fileify_dirspec_utf8
983                       Perl_fileify_dirspec_utf8_ts
984                       Perl_flex_fstat
985                       Perl_flex_lstat
986                       Perl_flex_stat
987                       Perl_kill_file
988                       Perl_my_chdir
989                       Perl_my_chmod
990                       Perl_my_crypt
991                       Perl_my_endpwent
992                       Perl_my_fclose
993                       Perl_my_fdopen
994                       Perl_my_fgetname
995                       Perl_my_flush
996                       Perl_my_fwrite
997                       Perl_my_gconvert
998                       Perl_my_getenv
999                       Perl_my_getenv_len
1000                       Perl_my_getpwnam
1001                       Perl_my_getpwuid
1002                       Perl_my_gmtime
1003                       Perl_my_kill
1004                       Perl_my_killpg
1005                       Perl_my_localtime
1006                       Perl_my_mkdir
1007                       Perl_my_sigaction
1008                       Perl_my_symlink
1009                       Perl_my_time
1010                       Perl_my_tmpfile
1011                       Perl_my_trnlnm
1012                       Perl_my_utime
1013                       Perl_my_waitpid
1014                       Perl_opendir
1015                       Perl_pathify_dirspec
1016                       Perl_pathify_dirspec_ts
1017                       Perl_pathify_dirspec_utf8
1018                       Perl_pathify_dirspec_utf8_ts
1019                       Perl_readdir
1020                       Perl_readdir_r
1021                       Perl_rename
1022                       Perl_rmscopy
1023                       Perl_rmsexpand
1024                       Perl_rmsexpand_ts
1025                       Perl_rmsexpand_utf8
1026                       Perl_rmsexpand_utf8_ts
1027                       Perl_seekdir
1028                       Perl_sig_to_vmscondition
1029                       Perl_telldir
1030                       Perl_tounixpath
1031                       Perl_tounixpath_ts
1032                       Perl_tounixpath_utf8
1033                       Perl_tounixpath_utf8_ts
1034                       Perl_tounixspec
1035                       Perl_tounixspec_ts
1036                       Perl_tounixspec_utf8
1037                       Perl_tounixspec_utf8_ts
1038                       Perl_tovmspath
1039                       Perl_tovmspath_ts
1040                       Perl_tovmspath_utf8
1041                       Perl_tovmspath_utf8_ts
1042                       Perl_tovmsspec
1043                       Perl_tovmsspec_ts
1044                       Perl_tovmsspec_utf8
1045                       Perl_tovmsspec_utf8_ts
1046                       Perl_trim_unixpath
1047                       Perl_vms_case_tolerant
1048                       Perl_vms_do_aexec
1049                       Perl_vms_do_exec
1050                       Perl_vms_image_init
1051                       Perl_vms_realpath
1052                       Perl_vmssetenv
1053                       Perl_vmssetuserlnm
1054                       Perl_vmstrnenv
1055                       PerlIO_openn
1056                  ));
1057 }
1058 elsif ($ARGS{PLATFORM} eq 'os2') {
1059     try_symbols(qw(
1060                       ctermid
1061                       get_sysinfo
1062                       Perl_OS2_init
1063                       Perl_OS2_init3
1064                       Perl_OS2_term
1065                       OS2_Perl_data
1066                       dlopen
1067                       dlsym
1068                       dlerror
1069                       dlclose
1070                       dup2
1071                       dup
1072                       my_tmpfile
1073                       my_tmpnam
1074                       my_flock
1075                       my_rmdir
1076                       my_mkdir
1077                       my_getpwuid
1078                       my_getpwnam
1079                       my_getpwent
1080                       my_setpwent
1081                       my_endpwent
1082                       fork_with_resources
1083                       croak_with_os2error
1084                       setgrent
1085                       endgrent
1086                       getgrent
1087                       malloc_mutex
1088                       threads_mutex
1089                       nthreads
1090                       nthreads_cond
1091                       os2_cond_wait
1092                       os2_stat
1093                       os2_execname
1094                       async_mssleep
1095                       msCounter
1096                       InfoTable
1097                       pthread_join
1098                       pthread_create
1099                       pthread_detach
1100                       XS_Cwd_change_drive
1101                       XS_Cwd_current_drive
1102                       XS_Cwd_extLibpath
1103                       XS_Cwd_extLibpath_set
1104                       XS_Cwd_sys_abspath
1105                       XS_Cwd_sys_chdir
1106                       XS_Cwd_sys_cwd
1107                       XS_Cwd_sys_is_absolute
1108                       XS_Cwd_sys_is_relative
1109                       XS_Cwd_sys_is_rooted
1110                       XS_DynaLoader_mod2fname
1111                       XS_File__Copy_syscopy
1112                       Perl_Register_MQ
1113                       Perl_Deregister_MQ
1114                       Perl_Serve_Messages
1115                       Perl_Process_Messages
1116                       init_PMWIN_entries
1117                       PMWIN_entries
1118                       Perl_hab_GET
1119                       loadByOrdinal
1120                       pExtFCN
1121                       os2error
1122                       ResetWinError
1123                       CroakWinError
1124                       PL_do_undump
1125                  ));
1126 }
1127 elsif ($ARGS{PLATFORM} eq 'netware') {
1128     try_symbols(qw(
1129                         Perl_init_os_extras
1130                         Perl_thread_create
1131                         Perl_nw5_init
1132                         RunPerl
1133                         AllocStdPerl
1134                         FreeStdPerl
1135                         do_spawn2
1136                         do_aspawn
1137                         nw_uname
1138                         nw_stdin
1139                         nw_stdout
1140                         nw_stderr
1141                         nw_feof
1142                         nw_ferror
1143                         nw_fopen
1144                         nw_fclose
1145                         nw_clearerr
1146                         nw_getc
1147                         nw_fgets
1148                         nw_fputc
1149                         nw_fputs
1150                         nw_fflush
1151                         nw_ungetc
1152                         nw_fileno
1153                         nw_fdopen
1154                         nw_freopen
1155                         nw_fread
1156                         nw_fwrite
1157                         nw_setbuf
1158                         nw_setvbuf
1159                         nw_vfprintf
1160                         nw_ftell
1161                         nw_fseek
1162                         nw_rewind
1163                         nw_tmpfile
1164                         nw_fgetpos
1165                         nw_fsetpos
1166                         nw_dup
1167                         nw_access
1168                         nw_chmod
1169                         nw_chsize
1170                         nw_close
1171                         nw_dup2
1172                         nw_flock
1173                         nw_isatty
1174                         nw_link
1175                         nw_lseek
1176                         nw_stat
1177                         nw_mktemp
1178                         nw_open
1179                         nw_read
1180                         nw_rename
1181                         nw_setmode
1182                         nw_unlink
1183                         nw_utime
1184                         nw_write
1185                         nw_chdir
1186                         nw_rmdir
1187                         nw_closedir
1188                         nw_opendir
1189                         nw_readdir
1190                         nw_rewinddir
1191                         nw_seekdir
1192                         nw_telldir
1193                         nw_htonl
1194                         nw_htons
1195                         nw_ntohl
1196                         nw_ntohs
1197                         nw_accept
1198                         nw_bind
1199                         nw_connect
1200                         nw_endhostent
1201                         nw_endnetent
1202                         nw_endprotoent
1203                         nw_endservent
1204                         nw_gethostbyaddr
1205                         nw_gethostbyname
1206                         nw_gethostent
1207                         nw_gethostname
1208                         nw_getnetbyaddr
1209                         nw_getnetbyname
1210                         nw_getnetent
1211                         nw_getpeername
1212                         nw_getprotobyname
1213                         nw_getprotobynumber
1214                         nw_getprotoent
1215                         nw_getservbyname
1216                         nw_getservbyport
1217                         nw_getservent
1218                         nw_getsockname
1219                         nw_getsockopt
1220                         nw_inet_addr
1221                         nw_listen
1222                         nw_socket
1223                         nw_recv
1224                         nw_recvfrom
1225                         nw_select
1226                         nw_send
1227                         nw_sendto
1228                         nw_sethostent
1229                         nw_setnetent
1230                         nw_setprotoent
1231                         nw_setservent
1232                         nw_setsockopt
1233                         nw_inet_ntoa
1234                         nw_shutdown
1235                         nw_crypt
1236                         nw_execvp
1237                         nw_kill
1238                         nw_Popen
1239                         nw_Pclose
1240                         nw_Pipe
1241                         nw_times
1242                         nw_waitpid
1243                         nw_getpid
1244                         nw_spawnvp
1245                         nw_os_id
1246                         nw_open_osfhandle
1247                         nw_get_osfhandle
1248                         nw_abort
1249                         nw_sleep
1250                         nw_wait
1251                         nw_dynaload
1252                         nw_strerror
1253                         fnFpSetMode
1254                         fnInsertHashListAddrs
1255                         fnGetHashListAddrs
1256                         Perl_deb
1257                         Perl_sv_setsv
1258                         Perl_sv_catsv
1259                         Perl_sv_catpvn
1260                         Perl_sv_2pv
1261                         nw_freeenviron
1262                         Remove_Thread_Ctx
1263                  ));
1264 }
1265
1266 # When added this code was only run for Win32 and WinCE
1267 # Currently only Win32 links static extensions into the shared library.
1268 # The WinCE makefile doesn't appear to support static extensions, so this code
1269 # can't have any effect there.
1270 # The NetWare Makefile doesn't support static extensions (and hardcodes the
1271 # list of dynamic extensions, and the rules to build them)
1272 # For *nix (and presumably OS/2) with a shared libperl, Makefile.SH compiles
1273 # static extensions with -fPIC, but links them to perl, not libperl.so
1274 # The VMS build scripts don't yet implement static extensions at all.
1275
1276 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1277     # records of type boot_module for statically linked modules (except Dynaloader)
1278     my $static_ext = $Config{static_ext} // "";
1279     $static_ext =~ s/\//__/g;
1280     $static_ext =~ s/\bDynaLoader\b//;
1281     try_symbols(map {"boot_$_"} grep {/\S/} split /\s+/, $static_ext);
1282     try_symbols("init_Win32CORE") if $static_ext =~ /\bWin32CORE\b/;
1283 }
1284
1285 if ($ARGS{PLATFORM} eq 'os2') {
1286     my (%mapped, @missing);
1287     open MAP, '<', 'miniperl.map' or die 'Cannot read miniperl.map';
1288     /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
1289     close MAP or die 'Cannot close miniperl.map';
1290
1291     @missing = grep { !exists $mapped{$_} }
1292                     keys %export;
1293     @missing = grep { !exists $exportperlmalloc{$_} } @missing;
1294     delete $export{$_} foreach @missing;
1295 }
1296
1297 ###############################################################################
1298
1299 # Now all symbols should be defined because next we are going to output them.
1300
1301 # Start with platform specific headers:
1302
1303 if ($ARGS{PLATFORM} =~ /^win(?:32|ce)$/) {
1304     my $dll = $define{PERL_DLL} ? $define{PERL_DLL} =~ s/\.dll$//ir
1305         : "perl$Config{api_revision}$Config{api_version}";
1306     print "LIBRARY $dll\n";
1307     # The DESCRIPTION module definition file statement is not supported
1308     # by VC7 onwards.
1309     if ($ARGS{CCTYPE} =~ /^(?:MSVC60|GCC)$/) {
1310         print "DESCRIPTION 'Perl interpreter'\n";
1311     }
1312     print "EXPORTS\n";
1313 }
1314 elsif ($ARGS{PLATFORM} eq 'os2') {
1315     (my $v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
1316     $v .= '-thread' if $Config{archname} =~ /-thread/;
1317     (my $dll = $define{PERL_DLL}) =~ s/\.dll$//i;
1318     $v .= "\@$Config{perl_patchlevel}" if $Config{perl_patchlevel};
1319     my $d = "DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $Config{config_args}'";
1320     $d = substr($d, 0, 249) . "...'" if length $d > 253;
1321     print <<"---EOP---";
1322 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
1323 $d
1324 STACKSIZE 32768
1325 CODE LOADONCALL
1326 DATA LOADONCALL NONSHARED MULTIPLE
1327 EXPORTS
1328 ---EOP---
1329 }
1330 elsif ($ARGS{PLATFORM} eq 'aix') {
1331     my $OSVER = `uname -v`;
1332     chop $OSVER;
1333     my $OSREL = `uname -r`;
1334     chop $OSREL;
1335     if ($OSVER > 4 || ($OSVER == 4 && $OSREL >= 3)) {
1336         print "#! ..\n";
1337     } else {
1338         print "#!\n";
1339     }
1340 }
1341 elsif ($ARGS{PLATFORM} eq 'netware') {
1342         if ($ARGS{FILETYPE} eq 'def') {
1343         print "LIBRARY perl$Config{api_revision}$Config{api_version}\n";
1344         print "DESCRIPTION 'Perl interpreter for NetWare'\n";
1345         print "EXPORTS\n";
1346         }
1347 }
1348
1349 # Then the symbols
1350
1351 my @symbols = $fold ? sort {lc $a cmp lc $b} keys %export : sort keys %export;
1352 foreach my $symbol (@symbols) {
1353     if (PLATFORM eq 'win32' || PLATFORM eq 'wince') {
1354         # Remembering the origin file of each symbol is an alternative to PL_ matching
1355         if (substr($symbol, 0, 3) eq 'PL_') {
1356             print "\t$symbol DATA\n";
1357         }
1358         else {
1359             print "\t$symbol\n";
1360         }
1361     }
1362     elsif (PLATFORM eq 'os2') {
1363         printf qq(    %-31s \@%s\n),
1364           qq("$symbol"), $ordinal{$symbol} || ++$sym_ord;
1365         printf qq(    %-31s \@%s\n),
1366           qq("$exportperlmalloc{$symbol}" = "$symbol"),
1367           $ordinal{$exportperlmalloc{$symbol}} || ++$sym_ord
1368           if $exportperlmalloc and exists $exportperlmalloc{$symbol};
1369     }
1370     elsif (PLATFORM eq 'netware') {
1371         print "\t$symbol,\n";
1372     } else {
1373         print "$symbol\n";
1374     }
1375 }
1376
1377 # Then platform specific footers.
1378
1379 if ($ARGS{PLATFORM} eq 'os2') {
1380     print <<EOP;
1381     dll_perlmain=main
1382     fill_extLibpath
1383     dir_subst
1384     Perl_OS2_handler_install
1385
1386 ; LAST_ORDINAL=$sym_ord
1387 EOP
1388 }
1389
1390 1;