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