This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Let h2xs read multiple header files
[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#
36# Author: Charles Bailey bailey@genetics.upenn.edu
a0d0e21e
LW
37
38require 5.000;
39
40$debug = $ENV{'GEN_SHRFLS_DEBUG'};
a5f75d66 41
fc1ce8cc 42print "gen_shrfls.pl Rev. 14-Dec-1997\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 . . .
59$isvax = `\$ Write Sys\$Output F\$GetSyI(\"HW_MODEL\")` <= 1024;
60print "\$isvax: \\$isvax\\\n" if $debug;
61
a0d0e21e 62print "Input \$cc_cmd: \\$cc_cmd\\\n" if $debug;
4633a7c4 63$docc = ($cc_cmd !~ /^~~/);
a0d0e21e
LW
64print "\$docc = $docc\n" if $debug;
65
66if ($docc) {
67 # put quotes back onto defines - they were removed by DCL on the way in
68 if (($prefix,$defines,$suffix) =
69 ($cc_cmd =~ m#(.*)/Define=(.*?)([/\s].*)#i)) {
70 $defines =~ s/^\((.*)\)$/$1/;
71 @defines = split(/,/,$defines);
72 $cc_cmd = "$prefix/Define=(" . join(',',grep($_ = "\"$_\"",@defines))
73 . ')' . $suffix;
74 }
75 print "Filtered \$cc_cmd: \\$cc_cmd\\\n" if $debug;
76
4633a7c4
LW
77 # check for gcc - if present, we'll need to use MACRO hack to
78 # define global symbols for shared variables
79 $isvaxc = 0;
80 $isgcc = `$cc_cmd _nla0:/Version` =~ /GNU/
81 or 0; # make debug output nice
71be2cbc
PP
82 $isvaxc = (!$isgcc && $isvax &&
83 # Check exit status too, in case message is shut off
84 (`$cc_cmd /prefix=all _nla0:` =~ /IVQUAL/ || $? == 0x38240))
4633a7c4
LW
85 or 0; # again, make debug output nice
86 print "\$isgcc: $isgcc\n" if $debug;
87 print "\$isvaxc: $isvaxc\n" if $debug;
88
a0d0e21e
LW
89 if (-f 'perl.h') { $dir = '[]'; }
90 elsif (-f '[-]perl.h') { $dir = '[-]'; }
91 else { die "$0: Can't find perl.h\n"; }
92}
4633a7c4 93else {
a5f75d66 94 ($junk,$junk,$cpp_file,$cc_cmd) = split(/~~/,$cc_cmd,4);
482b294c 95 $isgcc = $cc_cmd =~ /case_hack/i
4633a7c4 96 or 0; # for nice debug output
482b294c 97 $isvaxc = (!$isgcc && $cc_cmd !~ /standard=/i)
4633a7c4
LW
98 or 0; # again, for nice debug output
99 print "\$isgcc: \\$isgcc\\\n" if $debug;
100 print "\$isvaxc: \\$isvaxc\\\n" if $debug;
101 print "Not running cc, preprocesor output in \\$cpp_file\\\n" if $debug;
102}
a0d0e21e
LW
103
104$objsuffix = shift @ARGV;
105print "\$objsuffix: \\$objsuffix\\\n" if $debug;
748a9306
LW
106$dbgprefix = shift @ARGV;
107print "\$dbgprefix: \\$dbgprefix\\\n" if $debug;
108$olbsuffix = shift @ARGV;
109print "\$olbsuffix: \\$olbsuffix\\\n" if $debug;
110$libperl = "${dbgprefix}libperl$olbsuffix";
111$extnames = shift @ARGV;
112print "\$extnames: \\$extnames\\\n" if $debug;
113$rtlopt = shift @ARGV;
114print "\$rtlopt: \\$rtlopt\\\n" if $debug;
a0d0e21e 115
e518068a 116# This part gets tricky. VAXC creates global symbols for each of the
4633a7c4
LW
117# constants in an enum if that enum is ever used as the data type of a
118# global[dr]ef. We have to detect enums which are used in this way, so we
119# can set up the constants as universal symbols, since anything which
120# #includes perl.h will want to resolve these global symbols.
121# We're using a weak test here - we basically know that the only enums
122# we need to handle now are the big one in opcode.h, and the
123# "typedef enum { ... } expectation" in perl.h, so we hard code
124# appropriate tests below. Since we can't know in general whether a given
125# enum will be used elsewhere in a globaldef, it's hard to decide a
126# priori whether its constants need to be treated as global symbols.
127sub scan_enum {
128 my($line) = @_;
129
130 return unless $isvaxc;
131
132 return unless /^\s+(OP|X)/; # we only want opcode and expectation enums
133 print "\tchecking for enum constant\n" if $debug > 1;
134 $line =~ s#/\*.+##;
135 $line =~ s/,?\s*\n?$//;
136 print "\tfiltered to \\$line\\\n" if $debug > 1;
137 if ($line =~ /(\w+)$/) {
c07a80fd
PP
138 print "\tconstant name is \\$1\\\n" if $debug > 1;
139 $enums{$1}++;
4633a7c4
LW
140 }
141}
a0d0e21e
LW
142
143sub scan_var {
144 my($line) = @_;
71be2cbc 145 my($const) = $line =~ /^EXTCONST/;
a0d0e21e 146
748a9306 147 print "\tchecking for global variable\n" if $debug > 1;
3e3baf6d
TB
148 $line =~ s/\s*EXT/EXT/;
149 $line =~ s/INIT\s*\(.*\)//;
a0d0e21e
LW
150 $line =~ s/\[.*//;
151 $line =~ s/=.*//;
152 $line =~ s/\W*;?\s*$//;
61bb5906 153 $line =~ s/\W*\)\s*\(.*$//; # closing paren for args stripped in previous stmt
748a9306 154 print "\tfiltered to \\$line\\\n" if $debug > 1;
a0d0e21e 155 if ($line =~ /(\w+)$/) {
71be2cbc
PP
156 print "\tvar name is \\$1\\" . ($const ? ' (const)' : '') . "\n" if $debug > 1;
157 if ($const) { $cvars{$1}++; }
158 else { $vars{$1}++; }
159 }
160 if ($isvaxc) {
3e3baf6d 161 my($type) = $line =~ /^\s*EXT\w*\s+(\w+)/;
71be2cbc
PP
162 print "\tchecking for use of enum (type is \"$type\")\n" if $debug > 2;
163 if ($type eq 'expectation') {
164 $used_expectation_enum++;
165 print "\tsaw global use of enum \"expectation\"\n" if $debug > 1;
166 }
167 if ($type eq 'opcode') {
168 $used_opcode_enum++;
169 print "\tsaw global use of enum \"opcode\"\n" if $debug > 1;
170 }
a0d0e21e
LW
171 }
172}
173
174sub scan_func {
175 my($line) = @_;
176
748a9306 177 print "\tchecking for global routine\n" if $debug > 1;
b9f71c63 178 if ( $line =~ /(\w+)\s+\(/ ) {
748a9306 179 print "\troutine name is \\$1\\\n" if $debug > 1;
a0d0e21e 180 if ($1 eq 'main' || $1 eq 'perl_init_ext') {
748a9306 181 print "\tskipped\n" if $debug > 1;
a0d0e21e 182 }
4633a7c4 183 else { $fcns{$1}++ }
a0d0e21e
LW
184 }
185}
186
c07a80fd 187$used_expectation_enum = $used_opcode_enum = 0; # avoid warnings
a0d0e21e
LW
188if ($docc) {
189 open(CPP,"${cc_cmd}/NoObj/PreProc=Sys\$Output ${dir}perl.h|")
190 or die "$0: Can't preprocess ${dir}perl.h: $!\n";
191}
192else {
a5f75d66 193 open(CPP,"$cpp_file") or die "$0: Can't read preprocessed file $cpp_file: $!\n";
a0d0e21e
LW
194}
195LINE: while (<CPP>) {
196 while (/^#.*vmsish\.h/i .. /^#.*perl\.h/i) {
197 while (/__VMS_PROTOTYPES__/i .. /__VMS_SEPYTOTORP__/i) {
748a9306 198 print "vms_proto>> $_" if $debug > 2;
3e3baf6d 199 if (/^\s*EXT/) { &scan_var($_); }
b9f71c63 200 else { &scan_func($_); }
a0d0e21e
LW
201 last LINE unless $_ = <CPP>;
202 }
748a9306 203 print "vmsish.h>> $_" if $debug > 2;
3e3baf6d 204 if (/^\s*EXT/) { &scan_var($_); }
a0d0e21e
LW
205 last LINE unless $_ = <CPP>;
206 }
207 while (/^#.*opcode\.h/i .. /^#.*perl\.h/i) {
748a9306 208 print "opcode.h>> $_" if $debug > 2;
a0d0e21e 209 if (/^OP \*\s/) { &scan_func($_); }
3e3baf6d 210 if (/^\s*EXT/) { &scan_var($_); }
4633a7c4
LW
211 if (/^\s+OP_/) { &scan_enum($_); }
212 last LINE unless $_ = <CPP>;
213 }
214 while (/^typedef enum/ .. /^\}/) {
215 print "global enum>> $_" if $debug > 2;
216 &scan_enum($_);
a0d0e21e
LW
217 last LINE unless $_ = <CPP>;
218 }
61bb5906
CB
219 while (/^#.*thread\.h/i .. /^#.*perl\.h/i) {
220 print "thread.h>> $_" if $debug > 2;
221 if (/\s*^EXT/) { &scan_var($_); }
222 else { &scan_func($_); }
223 last LINE unless $_ = <CPP>;
224 }
a0d0e21e 225 while (/^#.*proto\.h/i .. /^#.*perl\.h/i) {
748a9306 226 print "proto.h>> $_" if $debug > 2;
3e3baf6d 227 if (/\s*^EXT/) { &scan_var($_); }
b9f71c63 228 else { &scan_func($_); }
a0d0e21e
LW
229 last LINE unless $_ = <CPP>;
230 }
71be2cbc 231 print $_ if $debug > 3 && ($debug > 5 || length($_));
3e3baf6d 232 if (/^\s*EXT/) { &scan_var($_); }
a0d0e21e
LW
233}
234close CPP;
b9f71c63
PP
235
236
237# Kluge to determine whether we need to add EMBED prefix to
740ce14c 238# symbols read from local list. vmsreaddirversions() is a VMS-
b9f71c63
PP
239# specific function whose Perl_ prefix is added in vmsish.h
240# if EMBED is #defined.
740ce14c 241$embed = exists($fcns{'Perl_vmsreaddirversions'}) ? 'Perl_' : '';
a0d0e21e
LW
242while (<DATA>) {
243 next if /^#/;
244 s/\s+#.*\n//;
4633a7c4 245 next if /^\s*$/;
a0d0e21e 246 ($key,$array) = split('=',$_);
b9f71c63 247 $key = "$embed$key";
748a9306 248 print "Adding $key to \%$array list\n" if $debug > 1;
a0d0e21e
LW
249 ${$array}{$key}++;
250}
748a9306
LW
251foreach (split /\s+/, $extnames) {
252 my($pkgname) = $_;
253 $pkgname =~ s/::/__/g;
4633a7c4
LW
254 $fcns{"boot_$pkgname"}++;
255 print "Adding boot_$pkgname to \%fcns (for extension $_)\n" if $debug;
748a9306 256}
a0d0e21e 257
c07a80fd
PP
258# If we're using VAXC, fold in the names of the constants for enums
259# we've seen as the type of global vars.
260if ($isvaxc) {
261 foreach (keys %enums) {
262 if (/^OP/) {
263 $vars{$_}++ if $used_opcode_enum;
264 next;
265 }
266 if (/^X/) {
267 $vars{$_}++ if $used_expectation_enum;
268 next;
269 }
270 print STDERR "Unrecognized enum constant \"$_\" ignored\n";
271 }
272}
cbb1213b
PP
273elsif ($isgcc) {
274 # gcc creates this as a SHR,WRT psect in globals.c, but we
275 # don't see it in the perl.h scan, since it's only declared
276 # if DOINIT is #defined. Bleah. It's cheaper to just add
277 # it by hand than to add /Define=DOINIT to the preprocessing
278 # run and wade through all the extra junk.
2ae324a7 279 $vars{"${embed}Error"}++;
cbb1213b 280}
c07a80fd 281
a0d0e21e
LW
282# Eventually, we'll check against existing copies here, so we can add new
283# symbols to an existing options file in an upwardly-compatible manner.
284
285$marord++;
748a9306
LW
286open(OPTBLD,">${dir}${dbgprefix}perlshr_bld.opt")
287 or die "$0: Can't write to ${dir}${dbgprefix}perlshr_bld.opt: $!\n";
a0d0e21e
LW
288if ($isvax) {
289 open(MAR,">${dir}perlshr_gbl${marord}.mar")
290 or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
748a9306 291 print MAR "\t.title perlshr_gbl$marord\n";
a0d0e21e 292}
71be2cbc
PP
293unless ($isgcc) {
294 print OPTBLD "PSECT_ATTR=\$GLOBAL_RO_VARS,PIC,NOEXE,RD,NOWRT,SHR\n";
295 print OPTBLD "PSECT_ATTR=\$GLOBAL_RW_VARS,PIC,NOEXE,RD,WRT,NOSHR\n";
296}
297foreach $var (sort (keys %vars,keys %cvars)) {
748a9306
LW
298 if ($isvax) { print OPTBLD "UNIVERSAL=$var\n"; }
299 else { print OPTBLD "SYMBOL_VECTOR=($var=DATA)\n"; }
4633a7c4
LW
300 # This hack brought to you by the lack of a globaldef in gcc.
301 if ($isgcc) {
a0d0e21e
LW
302 if ($count++ > 200) { # max 254 psects/file
303 print MAR "\t.end\n";
304 close MAR;
305 $marord++;
306 open(MAR,">${dir}perlshr_gbl${marord}.mar")
307 or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
748a9306 308 print MAR "\t.title perlshr_gbl$marord\n";
a0d0e21e
LW
309 $count = 0;
310 }
a0d0e21e
LW
311 print MAR "\t.psect ${var},long,pic,ovr,rd,wrt,noexe,noshr\n";
312 print MAR "\t${var}:: .blkl 1\n";
313 }
314}
315
316print MAR "\t.psect \$transfer_vec,pic,rd,nowrt,exe,shr\n" if ($isvax);
4633a7c4 317foreach $func (sort keys %fcns) {
a0d0e21e
LW
318 if ($isvax) {
319 print MAR "\t.transfer $func\n";
320 print MAR "\t.mask $func\n";
4633a7c4 321 print MAR "\tjmp G\^${func}+2\n";
a0d0e21e 322 }
748a9306 323 else { print OPTBLD "SYMBOL_VECTOR=($func=PROCEDURE)\n"; }
a0d0e21e 324}
4633a7c4
LW
325if ($isvax) {
326 print MAR "\t.end\n";
327 close MAR;
328}
a0d0e21e 329
4633a7c4
LW
330open(OPTATTR,">${dir}perlshr_attr.opt")
331 or die "$0: Can't write to ${dir}perlshr_attr.opt: $!\n";
71be2cbc
PP
332if ($isvaxc) {
333 print OPTATTR "PSECT_ATTR=\$CHAR_STRING_CONSTANTS,PIC,SHR,NOEXE,RD,NOWRT\n";
334}
335elsif ($isgcc) {
336 foreach $var (sort keys %cvars) {
337 print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,NOWRT,SHR\n";
338 }
339 foreach $var (sort keys %vars) {
340 print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
341 }
342}
343else {
344 print OPTATTR "! No additional linker directives are needed when using DECC\n";
4633a7c4 345}
a0d0e21e 346close OPTATTR;
4633a7c4 347
748a9306 348$incstr = 'perl,globals';
a0d0e21e 349if ($isvax) {
a0d0e21e
LW
350 $drvrname = "Compile_shrmars.tmp_".time;
351 open (DRVR,">$drvrname") or die "$0: Can't write to $drvrname: $!\n";
352 print DRVR "\$ Set NoOn\n";
353 print DRVR "\$ Delete/NoLog/NoConfirm $drvrname;\n";
354 print DRVR "\$ old_proc_vfy = F\$Environment(\"VERIFY_PROCEDURE\")\n";
355 print DRVR "\$ old_img_vfy = F\$Environment(\"VERIFY_IMAGE\")\n";
748a9306 356 print DRVR "\$ MCR $^X -e \"\$ENV{'LIBPERL_RDT'} = (stat('$libperl'))[9]\"\n";
a0d0e21e 357 print DRVR "\$ Set Verify\n";
748a9306 358 print DRVR "\$ If F\$Search(\"$libperl\").eqs.\"\" Then Library/Object/Create $libperl\n";
a0d0e21e 359 do {
bbce6d69 360 push(@symfiles,"perlshr_gbl$marord");
a0d0e21e 361 print DRVR "\$ Macro/NoDebug/Object=PerlShr_Gbl${marord}$objsuffix PerlShr_Gbl$marord.Mar\n";
748a9306 362 print DRVR "\$ Library/Object/Replace/Log $libperl PerlShr_Gbl${marord}$objsuffix\n";
a0d0e21e 363 } while (--$marord);
748a9306
LW
364 # We had to have a working miniperl to run this program; it's probably the
365 # one we just built. It depended on LibPerl, which will be changed when
366 # the PerlShr_Gbl* modules get inserted, so miniperl will be out of date,
367 # and so, therefore, will all of its dependents . . .
368 # We touch LibPerl here so it'll be back 'in date', and we won't rebuild
369 # miniperl etc., and therefore LibPerl, the next time we invoke MM[KS].
a0d0e21e 370 print DRVR "\$ old_proc_vfy = F\$Verify(old_proc_vfy,old_img_vfy)\n";
748a9306 371 print DRVR "\$ MCR $^X -e \"utime 0, \$ENV{'LIBPERL_RDT'}, '$libperl'\"\n";
a0d0e21e 372 close DRVR;
a0d0e21e 373}
748a9306 374
bbce6d69
PP
375# Initial hack to permit building of compatible shareable images for a
376# given version of Perl.
377if ($ENV{PERLSHR_USE_GSMATCH}) {
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 foreach (@symfiles) {
61bb5906 382 print OPTBLD "CLUSTER=\$\$TRANSFER_VECTOR,,,$_$objsuffix\n";
bbce6d69
PP
383 }
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
a0d0e21e 401rcsid=vars # declared in perl.c
a0d0e21e
LW
402regkind=vars # declared in regcomp.h
403simple=vars # declared in regcomp.h
404varies=vars # declared in regcomp.h
405watchaddr=vars # declared in run.c
406watchok=vars # declared in run.c
407yychar=vars # generated by byacc in perly.c
408yycheck=vars # generated by byacc in perly.c
409yydebug=vars # generated by byacc in perly.c
410yydefred=vars # generated by byacc in perly.c
411yydgoto=vars # generated by byacc in perly.c
412yyerrflag=vars # generated by byacc in perly.c
413yygindex=vars # generated by byacc in perly.c
414yylen=vars # generated by byacc in perly.c
415yylhs=vars # generated by byacc in perly.c
416yylval=vars # generated by byacc in perly.c
417yyname=vars # generated by byacc in perly.c
418yynerrs=vars # generated by byacc in perly.c
419yyrindex=vars # generated by byacc in perly.c
420yyrule=vars # generated by byacc in perly.c
421yysindex=vars # generated by byacc in perly.c
422yytable=vars # generated by byacc in perly.c
423yyval=vars # generated by byacc in perly.c