This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Don't export symbols for routines that don't exist.
[perl5.git] / vms / gen_shrfls.pl
CommitLineData
a0d0e21e
LW
1# Create global symbol declarations, transfer vector, and
2# linker options files for PerlShr.
3#
4# Input:
5# $cflags - command line qualifiers passed to cc when preprocesing perl.h
6# Note: A rather simple-minded attempt is made to restore quotes to
7# a /Define clause - use with care.
8# $objsuffix - file type (including '.') used for object files.
748a9306
LW
9# $libperl - Perl object library.
10# $extnames - package names for static extensions (used to generate
11# linker options file entries for boot functions)
12# $rtlopt - name of options file specifying RTLs to which PerlShr.Exe
13# must be linked
a0d0e21e
LW
14#
15# Output:
16# PerlShr_Attr.Opt - linker options file which speficies that global vars
17# be placed in NOSHR,WRT psects. Use when linking any object files
18# against PerlShr.Exe, since cc places global vars in SHR,WRT psects
19# by default.
748a9306 20# PerlShr_Bld.Opt - declares universal symbols for PerlShr.Exe
a0d0e21e
LW
21# Perlshr_Gbl*.Mar, Perlshr_Gbl*.Obj (VAX only) - declares global symbols
22# for global vars (done here because gcc can't globaldef) and creates
23# transfer vectors for routines on a VAX.
24# PerlShr_Gbl.Opt (VAX only) - list of PerlShr_Gbl*.Obj, used for input
25# to the linker when building PerlShr.Exe.
26#
27# To do:
28# - figure out a good way to collect global vars in one psect, given that
29# we can't use globaldef because of gcc.
30# - then, check for existing files and preserve symbol and transfer vector
31# order for upward compatibility
32# - then, add GSMATCH to options file - but how do we insure that new
33# library has everything old one did
34# (i.e. /Define=DEBUGGING,EMBED,MULTIPLICITY)?
35#
bd3fa61c 36# Author: Charles Bailey bailey@newman.upenn.edu
a0d0e21e
LW
37
38require 5.000;
39
40$debug = $ENV{'GEN_SHRFLS_DEBUG'};
a5f75d66 41
a50752f9 42print "gen_shrfls.pl Rev. 18-Dec-2003\n" if $debug;
71be2cbc 43
a5f75d66
AD
44if ($ARGV[0] eq '-f') {
45 open(INP,$ARGV[1]) or die "Can't read input file $ARGV[1]: $!\n";
46 print "Input taken from file $ARGV[1]\n" if $debug;
47 @ARGV = ();
48 while (<INP>) {
49 chomp;
50 push(@ARGV,split(/\|/,$_));
51 }
52 close INP;
53 print "Read input data | ",join(' | ',@ARGV)," |\n" if $debug > 1;
54}
55
a0d0e21e 56$cc_cmd = shift @ARGV;
4633a7c4
LW
57
58# Someday, we'll have $GetSyI built into perl . . .
a50752f9
CB
59$isvax = `\$ Write Sys\$Output \(F\$GetSyI(\"HW_MODEL\") .LE. 1024 .AND. F\$GetSyI(\"HW_MODEL\") .GT. 0\)`;
60chomp $isvax;
4633a7c4
LW
61print "\$isvax: \\$isvax\\\n" if $debug;
62
2ee88f01 63$isi64 = `\$ Write Sys\$Output \(F\$GetSyI(\"HW_MODEL\") .GE. 4096)`;
e8e09534
PP
64chomp $isi64;
65print "\$isi64: \\$isi64\\\n" if $debug;
66
a0d0e21e 67print "Input \$cc_cmd: \\$cc_cmd\\\n" if $debug;
4633a7c4 68$docc = ($cc_cmd !~ /^~~/);
a0d0e21e
LW
69print "\$docc = $docc\n" if $debug;
70
71if ($docc) {
429a5e67
DS
72 if (-f 'perl.h') { $dir = '[]'; }
73 elsif (-f '[-]perl.h') { $dir = '[-]'; }
74 else { die "$0: Can't find perl.h\n"; }
75
de4b552e 76 $use_threads = $use_mymalloc = $case_about_case = $debugging_enabled = 0;
a15cef0c 77 $hide_mymalloc = $isgcc = $use_perlio = 0;
de4b552e 78
403396f3
CL
79 # Go see what is enabled in config.sh
80 $config = $dir . "config.sh";
429a5e67
DS
81 open CONFIG, "< $config";
82 while(<CONFIG>) {
ac25e0e7 83 $use_threads++ if /usethreads='(define|yes|true|t|y|1)'/i;
cbe4ad0c 84 $use_mymalloc++ if /usemymalloc='(define|yes|true|t|y|1)'/i;
ac25e0e7
CL
85 $care_about_case++ if /d_vms_case_sensitive_symbols='(define|yes|true|t|y|1)'/i;
86 $debugging_enabled++ if /usedebugging_perl='(define|yes|true|t|y|1)'/i;
87 $hide_mymalloc++ if /embedmymalloc='(define|yes|true|t|y|1)'/i;
de4b552e 88 $isgcc++ if /gccversion='[^']/;
ac25e0e7 89 $use_perlio++ if /useperlio='(define|yes|true|t|y|1)'/i;
429a5e67 90 }
403396f3 91 close CONFIG;
429a5e67 92
a0d0e21e
LW
93 # put quotes back onto defines - they were removed by DCL on the way in
94 if (($prefix,$defines,$suffix) =
95 ($cc_cmd =~ m#(.*)/Define=(.*?)([/\s].*)#i)) {
96 $defines =~ s/^\((.*)\)$/$1/;
429a5e67 97 $debugging_enabled ||= $defines =~ /\bDEBUGGING\b/;
a0d0e21e
LW
98 @defines = split(/,/,$defines);
99 $cc_cmd = "$prefix/Define=(" . join(',',grep($_ = "\"$_\"",@defines))
100 . ')' . $suffix;
101 }
102 print "Filtered \$cc_cmd: \\$cc_cmd\\\n" if $debug;
103
4633a7c4
LW
104 # check for gcc - if present, we'll need to use MACRO hack to
105 # define global symbols for shared variables
de4b552e 106
4633a7c4 107 print "\$isgcc: $isgcc\n" if $debug;
09b7f37c 108 print "\$debugging_enabled: $debugging_enabled\n" if $debug;
4633a7c4 109
a0d0e21e 110}
4633a7c4 111else {
a5f75d66 112 ($junk,$junk,$cpp_file,$cc_cmd) = split(/~~/,$cc_cmd,4);
482b294c 113 $isgcc = $cc_cmd =~ /case_hack/i
4633a7c4 114 or 0; # for nice debug output
09b7f37c 115 $debugging_enabled = $cc_cmd =~ /\bdebugging\b/i;
4633a7c4 116 print "\$isgcc: \\$isgcc\\\n" if $debug;
09b7f37c 117 print "\$debugging_enabled: \\$debugging_enabled\\\n" if $debug;
4633a7c4
LW
118 print "Not running cc, preprocesor output in \\$cpp_file\\\n" if $debug;
119}
a0d0e21e
LW
120
121$objsuffix = shift @ARGV;
122print "\$objsuffix: \\$objsuffix\\\n" if $debug;
748a9306
LW
123$dbgprefix = shift @ARGV;
124print "\$dbgprefix: \\$dbgprefix\\\n" if $debug;
125$olbsuffix = shift @ARGV;
126print "\$olbsuffix: \\$olbsuffix\\\n" if $debug;
127$libperl = "${dbgprefix}libperl$olbsuffix";
128$extnames = shift @ARGV;
129print "\$extnames: \\$extnames\\\n" if $debug;
130$rtlopt = shift @ARGV;
131print "\$rtlopt: \\$rtlopt\\\n" if $debug;
a0d0e21e 132
a0d0e21e
LW
133sub scan_var {
134 my($line) = @_;
71be2cbc 135 my($const) = $line =~ /^EXTCONST/;
a0d0e21e 136
748a9306 137 print "\tchecking for global variable\n" if $debug > 1;
3e3baf6d
TB
138 $line =~ s/\s*EXT/EXT/;
139 $line =~ s/INIT\s*\(.*\)//;
a0d0e21e
LW
140 $line =~ s/\[.*//;
141 $line =~ s/=.*//;
142 $line =~ s/\W*;?\s*$//;
61bb5906 143 $line =~ s/\W*\)\s*\(.*$//; # closing paren for args stripped in previous stmt
748a9306 144 print "\tfiltered to \\$line\\\n" if $debug > 1;
a0d0e21e 145 if ($line =~ /(\w+)$/) {
71be2cbc 146 print "\tvar name is \\$1\\" . ($const ? ' (const)' : '') . "\n" if $debug > 1;
147 if ($const) { $cvars{$1}++; }
148 else { $vars{$1}++; }
149 }
a0d0e21e
LW
150}
151
152sub scan_func {
b37f629b
CB
153 my @lines = split /;/, @_[0];
154
155 for my $line (@lines) {
156 print "\tchecking for global routine\n" if $debug > 1;
9396c84f 157 $line =~ s/\b(IV|Off_t|Size_t|SSize_t|void|int)\b//i;
b37f629b
CB
158 if ( $line =~ /(\w+)\s*\(/ ) {
159 print "\troutine name is \\$1\\\n" if $debug > 1;
160 if ($1 eq 'main' || $1 eq 'perl_init_ext' || $1 eq '__attribute__format__'
6c2fd45e
CB
161 || $1 eq 'sizeof' || (($1 eq 'Perl_stashpv_hvname_match') && ! $use_threads)
162 || $1 eq 'Perl_pp_avalues' || $1 eq 'Perl_pp_say') {
b37f629b
CB
163 print "\tskipped\n" if $debug > 1;
164 }
165 else { $fcns{$1}++ }
a0d0e21e 166 }
a0d0e21e
LW
167 }
168}
169
429a5e67
DS
170# Go add some right up front if we need 'em
171if ($use_mymalloc) {
b6837a3b
CB
172 $fcns{'Perl_malloc'}++;
173 $fcns{'Perl_calloc'}++;
174 $fcns{'Perl_realloc'}++;
175 $fcns{'Perl_mfree'}++;
429a5e67
DS
176}
177
c07a80fd 178$used_expectation_enum = $used_opcode_enum = 0; # avoid warnings
a0d0e21e 179if ($docc) {
77227254
CB
180 1 while unlink 'perlincludes.tmp';
181 END { 1 while unlink 'perlincludes.tmp'; } # and clean up after
182
183 open(PERLINC, '>perlincludes.tmp') or die "Couldn't open 'perlincludes.tmp' $!";
184
185 print PERLINC qq/#include "${dir}perl.h"\n/;
186 print PERLINC qq/#include "${dir}perlapi.h"\n/;
187 print PERLINC qq/#include "${dir}perliol.h"\n/ if $use_perlio;
188 print PERLINC qq/#include "${dir}regcomp.h"\n/;
189
190 close PERLINC;
191 $preprocess_list = 'perlincludes.tmp';
192
a15cef0c
CB
193 open(CPP,"${cc_cmd}/NoObj/PreProc=Sys\$Output $preprocess_list|")
194 or die "$0: Can't preprocess $preprocess_list: $!\n";
a0d0e21e
LW
195}
196else {
a5f75d66 197 open(CPP,"$cpp_file") or die "$0: Can't read preprocessed file $cpp_file: $!\n";
a0d0e21e 198}
77227254
CB
199%checkh = map { $_,1 } qw( bytecode byterun intrpvar perlapi perlio perliol
200 perlvars proto regcomp thrdvar thread );
09b7f37c 201$ckfunc = 0;
a0d0e21e
LW
202LINE: while (<CPP>) {
203 while (/^#.*vmsish\.h/i .. /^#.*perl\.h/i) {
204 while (/__VMS_PROTOTYPES__/i .. /__VMS_SEPYTOTORP__/i) {
748a9306 205 print "vms_proto>> $_" if $debug > 2;
9947c4e3 206 if (/^\s*EXT(CONST|\s+)/) { &scan_var($_); }
b9f71c63 207 else { &scan_func($_); }
09b7f37c 208 last LINE unless defined($_ = <CPP>);
a0d0e21e 209 }
748a9306 210 print "vmsish.h>> $_" if $debug > 2;
9947c4e3 211 if (/^\s*EXT(CONST|\s+)/) { &scan_var($_); }
09b7f37c 212 last LINE unless defined($_ = <CPP>);
a0d0e21e
LW
213 }
214 while (/^#.*opcode\.h/i .. /^#.*perl\.h/i) {
748a9306 215 print "opcode.h>> $_" if $debug > 2;
a0d0e21e 216 if (/^OP \*\s/) { &scan_func($_); }
9947c4e3 217 if (/^\s*EXT(CONST|\s+)/) { &scan_var($_); }
09b7f37c 218 last LINE unless defined($_ = <CPP>);
a0d0e21e 219 }
09b7f37c
CB
220 # Check for transition to new header file
221 if (/^# \d+ "(\S+)"/) {
222 my $spec = $1;
223 # Pull name from library module or header filespec
224 $spec =~ /^(\w+)$/ or $spec =~ /(\w+)\.h/i;
225 my $name = lc $1;
226 $ckfunc = exists $checkh{$name} ? 1 : 0;
227 $scanname = $name if $ckfunc;
228 print "Header file transition: ckfunc = $ckfunc for $name.h\n" if $debug > 1;
61bb5906 229 }
09b7f37c
CB
230 if ($ckfunc) {
231 print "$scanname>> $_" if $debug > 2;
9947c4e3 232 if (/^\s*EXT(CONST|\s+)/) { &scan_var($_); }
09b7f37c
CB
233 else { &scan_func($_); }
234 }
235 else {
236 print $_ if $debug > 3 && ($debug > 5 || length($_));
9947c4e3 237 if (/^\s*EXT(CONST|\s+)/) { &scan_var($_); }
a0d0e21e 238 }
a0d0e21e
LW
239}
240close CPP;
b9f71c63 241
a0d0e21e
LW
242while (<DATA>) {
243 next if /^#/;
244 s/\s+#.*\n//;
4633a7c4 245 next if /^\s*$/;
a0d0e21e 246 ($key,$array) = split('=',$_);
cc391245
CB
247 if ($array eq 'vars') { $key = "PL_$key"; }
248 else { $key = "Perl_$key"; }
748a9306 249 print "Adding $key to \%$array list\n" if $debug > 1;
a0d0e21e
LW
250 ${$array}{$key}++;
251}
9ef4b0a6 252if ($debugging_enabled and $isgcc) { $vars{'colors'}++ }
748a9306
LW
253foreach (split /\s+/, $extnames) {
254 my($pkgname) = $_;
255 $pkgname =~ s/::/__/g;
4633a7c4
LW
256 $fcns{"boot_$pkgname"}++;
257 print "Adding boot_$pkgname to \%fcns (for extension $_)\n" if $debug;
748a9306 258}
a0d0e21e
LW
259
260# Eventually, we'll check against existing copies here, so we can add new
261# symbols to an existing options file in an upwardly-compatible manner.
262
263$marord++;
748a9306
LW
264open(OPTBLD,">${dir}${dbgprefix}perlshr_bld.opt")
265 or die "$0: Can't write to ${dir}${dbgprefix}perlshr_bld.opt: $!\n";
a0d0e21e
LW
266if ($isvax) {
267 open(MAR,">${dir}perlshr_gbl${marord}.mar")
268 or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
748a9306 269 print MAR "\t.title perlshr_gbl$marord\n";
a0d0e21e 270}
5e4ba136 271
71be2cbc 272unless ($isgcc) {
e8e09534
PP
273 if ($isi64) {
274 print OPTBLD "PSECT_ATTR=\$GLOBAL_RO_VARS,NOEXE,RD,NOWRT,SHR\n";
275 print OPTBLD "PSECT_ATTR=\$GLOBAL_RW_VARS,NOEXE,RD,WRT,NOSHR\n";
276 }
277 else {
278 print OPTBLD "PSECT_ATTR=\$GLOBAL_RO_VARS,PIC,NOEXE,RD,NOWRT,SHR\n";
279 print OPTBLD "PSECT_ATTR=\$GLOBAL_RW_VARS,PIC,NOEXE,RD,WRT,NOSHR\n";
280 }
71be2cbc 281}
b6837a3b 282print OPTBLD "case_sensitive=yes\n" if $care_about_case;
71be2cbc 283foreach $var (sort (keys %vars,keys %cvars)) {
748a9306
LW
284 if ($isvax) { print OPTBLD "UNIVERSAL=$var\n"; }
285 else { print OPTBLD "SYMBOL_VECTOR=($var=DATA)\n"; }
4633a7c4
LW
286 # This hack brought to you by the lack of a globaldef in gcc.
287 if ($isgcc) {
a0d0e21e
LW
288 if ($count++ > 200) { # max 254 psects/file
289 print MAR "\t.end\n";
290 close MAR;
291 $marord++;
292 open(MAR,">${dir}perlshr_gbl${marord}.mar")
293 or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
748a9306 294 print MAR "\t.title perlshr_gbl$marord\n";
a0d0e21e
LW
295 $count = 0;
296 }
a0d0e21e
LW
297 print MAR "\t.psect ${var},long,pic,ovr,rd,wrt,noexe,noshr\n";
298 print MAR "\t${var}:: .blkl 1\n";
299 }
300}
301
302print MAR "\t.psect \$transfer_vec,pic,rd,nowrt,exe,shr\n" if ($isvax);
4633a7c4 303foreach $func (sort keys %fcns) {
a0d0e21e
LW
304 if ($isvax) {
305 print MAR "\t.transfer $func\n";
306 print MAR "\t.mask $func\n";
4633a7c4 307 print MAR "\tjmp G\^${func}+2\n";
a0d0e21e 308 }
748a9306 309 else { print OPTBLD "SYMBOL_VECTOR=($func=PROCEDURE)\n"; }
a0d0e21e 310}
4633a7c4
LW
311if ($isvax) {
312 print MAR "\t.end\n";
313 close MAR;
314}
a0d0e21e 315
4633a7c4
LW
316open(OPTATTR,">${dir}perlshr_attr.opt")
317 or die "$0: Can't write to ${dir}perlshr_attr.opt: $!\n";
ecc0eccd 318if ($isgcc) {
71be2cbc 319 foreach $var (sort keys %cvars) {
320 print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,NOWRT,SHR\n";
321 }
322 foreach $var (sort keys %vars) {
323 print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
324 }
325}
326else {
327 print OPTATTR "! No additional linker directives are needed when using DECC\n";
4633a7c4 328}
a0d0e21e 329close OPTATTR;
4633a7c4 330
b6837a3b 331$incstr = 'PERL,GLOBALS';
a0d0e21e 332if ($isvax) {
a0d0e21e
LW
333 $drvrname = "Compile_shrmars.tmp_".time;
334 open (DRVR,">$drvrname") or die "$0: Can't write to $drvrname: $!\n";
335 print DRVR "\$ Set NoOn\n";
336 print DRVR "\$ Delete/NoLog/NoConfirm $drvrname;\n";
337 print DRVR "\$ old_proc_vfy = F\$Environment(\"VERIFY_PROCEDURE\")\n";
338 print DRVR "\$ old_img_vfy = F\$Environment(\"VERIFY_IMAGE\")\n";
748a9306 339 print DRVR "\$ MCR $^X -e \"\$ENV{'LIBPERL_RDT'} = (stat('$libperl'))[9]\"\n";
a0d0e21e 340 print DRVR "\$ Set Verify\n";
748a9306 341 print DRVR "\$ If F\$Search(\"$libperl\").eqs.\"\" Then Library/Object/Create $libperl\n";
a0d0e21e 342 do {
bbce6d69 343 push(@symfiles,"perlshr_gbl$marord");
a0d0e21e 344 print DRVR "\$ Macro/NoDebug/Object=PerlShr_Gbl${marord}$objsuffix PerlShr_Gbl$marord.Mar\n";
748a9306 345 print DRVR "\$ Library/Object/Replace/Log $libperl PerlShr_Gbl${marord}$objsuffix\n";
a0d0e21e 346 } while (--$marord);
748a9306
LW
347 # We had to have a working miniperl to run this program; it's probably the
348 # one we just built. It depended on LibPerl, which will be changed when
349 # the PerlShr_Gbl* modules get inserted, so miniperl will be out of date,
350 # and so, therefore, will all of its dependents . . .
351 # We touch LibPerl here so it'll be back 'in date', and we won't rebuild
352 # miniperl etc., and therefore LibPerl, the next time we invoke MM[KS].
a0d0e21e 353 print DRVR "\$ old_proc_vfy = F\$Verify(old_proc_vfy,old_img_vfy)\n";
748a9306 354 print DRVR "\$ MCR $^X -e \"utime 0, \$ENV{'LIBPERL_RDT'}, '$libperl'\"\n";
a0d0e21e 355 close DRVR;
a0d0e21e 356}
748a9306 357
bbce6d69 358# Initial hack to permit building of compatible shareable images for a
359# given version of Perl.
360if ($ENV{PERLSHR_USE_GSMATCH}) {
424a8fe9
CB
361 if ($ENV{PERLSHR_USE_GSMATCH} eq 'INCLUDE_COMPILE_OPTIONS') {
362 # Build up a major ID. Since it can only be 8 bits, we encode the version
363 # number in the top four bits and use the bottom four for build options
364 # that'll cause incompatibilities
365 ($ver, $sub) = $] =~ /\.(\d\d\d)(\d\d)/;
e4dfc136 366 $ver += 0; $sub += 0;
424a8fe9
CB
367 $gsmatch = ($sub >= 50) ? "equal" : "lequal"; # Force an equal match for
368 # dev, but be more forgiving
369 # for releases
370
371 $ver *=16;
372 $ver += 8 if $debugging_enabled; # If DEBUGGING is set
373 $ver += 4 if $use_threads; # if we're threaded
374 $ver += 2 if $use_mymalloc; # if we're using perl's malloc
375 print OPTBLD "GSMATCH=$gsmatch,$ver,$sub\n";
376 }
377 else {
378 my $major = int($] * 1000) & 0xFF; # range 0..255
379 my $minor = int(($] * 1000 - $major) * 100 + 0.5) & 0xFF; # range 0..255
380 print OPTBLD "GSMATCH=LEQUAL,$major,$minor\n";
381 }
09b7f37c
CB
382 print OPTBLD 'CLUSTER=$$TRANSFER_VECTOR,,',
383 map(",$_$objsuffix",@symfiles), "\n";
bbce6d69 384}
36477c24 385elsif (@symfiles) { $incstr .= ',' . join(',',@symfiles); }
748a9306
LW
386# Include object modules and RTLs in options file
387# Linker wants /Include and /Library on different lines
388print OPTBLD "$libperl/Include=($incstr)\n";
389print OPTBLD "$libperl/Library\n";
a5f75d66 390open(RTLOPT,$rtlopt) or die "$0: Can't read options file $rtlopt: $!\n";
748a9306
LW
391while (<RTLOPT>) { print OPTBLD; }
392close RTLOPT;
393close OPTBLD;
394
395exec "\$ \@$drvrname" if $isvax;
396
397
a0d0e21e
LW
398__END__
399
400# Oddball cases, so we can keep the perl.h scan above simple
9396c84f
CB
401#Foo=vars # uncommented becomes PL_Foo
402#Bar=funcs # uncommented becomes Perl_Bar