Fixup Win32
[p5sagit/p5-mst-13.2.git] / vms / gen_shrfls.pl
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.
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
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.
20 #    PerlShr_Bld.Opt - declares universal symbols for PerlShr.Exe
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
37
38 require 5.000;
39
40 $debug = $ENV{'GEN_SHRFLS_DEBUG'};
41
42 print "gen_shrfls.pl Rev. 14-Dec-1996\n" if $debug;
43
44 if ($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
56 $cc_cmd = shift @ARGV;
57
58 # Someday, we'll have $GetSyI built into perl . . .
59 $isvax = `\$ Write Sys\$Output F\$GetSyI(\"HW_MODEL\")` <= 1024;
60 print "\$isvax: \\$isvax\\\n" if $debug;
61
62 print "Input \$cc_cmd: \\$cc_cmd\\\n" if $debug;
63 $docc = ($cc_cmd !~ /^~~/);
64 print "\$docc = $docc\n" if $debug;
65
66 if ($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
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
82   $isvaxc = (!$isgcc && $isvax &&
83              # Check exit status too, in case message is shut off
84              (`$cc_cmd /prefix=all _nla0:` =~ /IVQUAL/ || $? == 0x38240))
85             or 0; # again, make debug output nice
86   print "\$isgcc: $isgcc\n" if $debug;
87   print "\$isvaxc: $isvaxc\n" if $debug;
88
89   if (-f 'perl.h') { $dir = '[]'; }
90   elsif (-f '[-]perl.h') { $dir = '[-]'; }
91   else { die "$0: Can't find perl.h\n"; }
92 }
93 else { 
94   ($junk,$junk,$cpp_file,$cc_cmd) = split(/~~/,$cc_cmd,4);
95   $isgcc = $cc_cmd =~ /case_hack/i
96            or 0;  # for nice debug output
97   $isvaxc = (!$isgcc && $cc_cmd !~ /standard=/i)
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 }
103
104 $objsuffix = shift @ARGV;
105 print "\$objsuffix: \\$objsuffix\\\n" if $debug;
106 $dbgprefix = shift @ARGV;
107 print "\$dbgprefix: \\$dbgprefix\\\n" if $debug;
108 $olbsuffix = shift @ARGV;
109 print "\$olbsuffix: \\$olbsuffix\\\n" if $debug;
110 $libperl = "${dbgprefix}libperl$olbsuffix";
111 $extnames = shift @ARGV;
112 print "\$extnames: \\$extnames\\\n" if $debug;
113 $rtlopt = shift @ARGV;
114 print "\$rtlopt: \\$rtlopt\\\n" if $debug;
115
116 # This part gets tricky.  VAXC creates global symbols for each of the
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.
127 sub 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+)$/) {
138     print "\tconstant name is \\$1\\\n" if $debug > 1;
139     $enums{$1}++;
140   }
141 }
142
143 sub scan_var {
144   my($line) = @_;
145   my($const) = $line =~ /^EXTCONST/;
146
147   print "\tchecking for global variable\n" if $debug > 1;
148   $line =~ s/\s*EXT/EXT/;
149   $line =~ s/INIT\s*\(.*\)//;
150   $line =~ s/\[.*//;
151   $line =~ s/=.*//;
152   $line =~ s/\W*;?\s*$//;
153   $line =~ s/\(void//;
154   print "\tfiltered to \\$line\\\n" if $debug > 1;
155   if ($line =~ /(\w+)$/) {
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) {
161     my($type) = $line =~ /^\s*EXT\w*\s+(\w+)/;
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     }
171   }
172 }
173
174 sub scan_func {
175   my($line) = @_;
176
177   print "\tchecking for global routine\n" if $debug > 1;
178   if ( $line =~ /(\w+)\s+\(/ ) {
179     print "\troutine name is \\$1\\\n" if $debug > 1;
180     if ($1 eq 'main' || $1 eq 'perl_init_ext') {
181       print "\tskipped\n" if $debug > 1;
182     }
183     else { $fcns{$1}++ }
184   }
185 }
186
187 $used_expectation_enum = $used_opcode_enum = 0; # avoid warnings
188 if ($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 }
192 else {
193   open(CPP,"$cpp_file") or die "$0: Can't read preprocessed file $cpp_file: $!\n";
194 }
195 LINE: while (<CPP>) {
196   while (/^#.*vmsish\.h/i .. /^#.*perl\.h/i) {
197     while (/__VMS_PROTOTYPES__/i .. /__VMS_SEPYTOTORP__/i) {
198       print "vms_proto>> $_" if $debug > 2;
199       if (/^\s*EXT/) { &scan_var($_);  }
200       else        { &scan_func($_); }
201       last LINE unless $_ = <CPP>;
202     }
203     print "vmsish.h>> $_" if $debug > 2;
204     if (/^\s*EXT/) { &scan_var($_); }
205     last LINE unless $_ = <CPP>;
206   }    
207   while (/^#.*opcode\.h/i .. /^#.*perl\.h/i) {
208     print "opcode.h>> $_" if $debug > 2;
209     if (/^OP \*\s/) { &scan_func($_); }
210     if (/^\s*EXT/) { &scan_var($_); }
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($_);
217     last LINE unless $_ = <CPP>;
218   }
219   while (/^#.*proto\.h/i .. /^#.*perl\.h/i) {
220     print "proto.h>> $_" if $debug > 2;
221     if (/\s*^EXT/) { &scan_var($_);  }
222     else        { &scan_func($_); }
223     last LINE unless $_ = <CPP>;
224   }
225   print $_ if $debug > 3 && ($debug > 5 || length($_));
226   if (/^\s*EXT/) { &scan_var($_); }
227 }
228 close CPP;
229
230
231 # Kluge to determine whether we need to add EMBED prefix to
232 # symbols read from local list.  vmsreaddirversions() is a VMS-
233 # specific function whose Perl_ prefix is added in vmsish.h
234 # if EMBED is #defined.
235 $embed = exists($fcns{'Perl_vmsreaddirversions'}) ? 'Perl_' : '';
236 while (<DATA>) {
237   next if /^#/;
238   s/\s+#.*\n//;
239   next if /^\s*$/;
240   ($key,$array) = split('=',$_);
241   $key = "$embed$key";
242   print "Adding $key to \%$array list\n" if $debug > 1;
243   ${$array}{$key}++;
244 }
245 foreach (split /\s+/, $extnames) {
246   my($pkgname) = $_;
247   $pkgname =~ s/::/__/g;
248   $fcns{"boot_$pkgname"}++;
249   print "Adding boot_$pkgname to \%fcns (for extension $_)\n" if $debug;
250 }
251
252 # If we're using VAXC, fold in the names of the constants for enums
253 # we've seen as the type of global vars.
254 if ($isvaxc) {
255   foreach (keys %enums) {
256     if (/^OP/) {
257       $vars{$_}++ if $used_opcode_enum;
258       next;
259     }
260     if (/^X/) {
261       $vars{$_}++ if $used_expectation_enum;
262       next;
263     }
264     print STDERR "Unrecognized enum constant \"$_\" ignored\n";
265   }
266 }
267 elsif ($isgcc) {
268   # gcc creates this as a SHR,WRT psect in globals.c, but we
269   # don't see it in the perl.h scan, since it's only declared
270   # if DOINIT is #defined.  Bleah.  It's cheaper to just add
271   # it by hand than to add /Define=DOINIT to the preprocessing
272   # run and wade through all the extra junk.
273   $vars{"${embed}Error"}++;
274 }
275
276 # Eventually, we'll check against existing copies here, so we can add new
277 # symbols to an existing options file in an upwardly-compatible manner.
278
279 $marord++;
280 open(OPTBLD,">${dir}${dbgprefix}perlshr_bld.opt")
281   or die "$0: Can't write to ${dir}${dbgprefix}perlshr_bld.opt: $!\n";
282 if ($isvax) {
283   open(MAR,">${dir}perlshr_gbl${marord}.mar")
284     or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
285   print MAR "\t.title perlshr_gbl$marord\n";
286 }
287 unless ($isgcc) {
288   print OPTBLD "PSECT_ATTR=\$GLOBAL_RO_VARS,PIC,NOEXE,RD,NOWRT,SHR\n";
289   print OPTBLD "PSECT_ATTR=\$GLOBAL_RW_VARS,PIC,NOEXE,RD,WRT,NOSHR\n";
290 }
291 foreach $var (sort (keys %vars,keys %cvars)) {
292   if ($isvax) { print OPTBLD "UNIVERSAL=$var\n"; }
293   else { print OPTBLD "SYMBOL_VECTOR=($var=DATA)\n"; }
294   # This hack brought to you by the lack of a globaldef in gcc.
295   if ($isgcc) {
296     if ($count++ > 200) {  # max 254 psects/file
297       print MAR "\t.end\n";
298       close MAR;
299       $marord++;
300       open(MAR,">${dir}perlshr_gbl${marord}.mar")
301         or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
302       print MAR "\t.title perlshr_gbl$marord\n";
303       $count = 0;
304     }
305     print MAR "\t.psect ${var},long,pic,ovr,rd,wrt,noexe,noshr\n";
306     print MAR "\t${var}::       .blkl 1\n";
307   }
308 }
309
310 print MAR "\t.psect \$transfer_vec,pic,rd,nowrt,exe,shr\n" if ($isvax);
311 foreach $func (sort keys %fcns) {
312   if ($isvax) {
313     print MAR "\t.transfer $func\n";
314     print MAR "\t.mask $func\n";
315     print MAR "\tjmp G\^${func}+2\n";
316   }
317   else { print OPTBLD "SYMBOL_VECTOR=($func=PROCEDURE)\n"; }
318 }
319 if ($isvax) {
320   print MAR "\t.end\n";
321   close MAR;
322 }
323
324 open(OPTATTR,">${dir}perlshr_attr.opt")
325   or die "$0: Can't write to ${dir}perlshr_attr.opt: $!\n";
326 if ($isvaxc) {
327   print OPTATTR "PSECT_ATTR=\$CHAR_STRING_CONSTANTS,PIC,SHR,NOEXE,RD,NOWRT\n";
328 }
329 elsif ($isgcc) {
330   foreach $var (sort keys %cvars) {
331     print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,NOWRT,SHR\n";
332   }
333   foreach $var (sort keys %vars) {
334     print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
335   }
336 }
337 else {
338   print OPTATTR "! No additional linker directives are needed when using DECC\n";
339 }
340 close OPTATTR;
341
342 $incstr = 'perl,globals';
343 if ($isvax) {
344   $drvrname = "Compile_shrmars.tmp_".time;
345   open (DRVR,">$drvrname") or die "$0: Can't write to $drvrname: $!\n";
346   print DRVR "\$ Set NoOn\n";  
347   print DRVR "\$ Delete/NoLog/NoConfirm $drvrname;\n";
348   print DRVR "\$ old_proc_vfy = F\$Environment(\"VERIFY_PROCEDURE\")\n";
349   print DRVR "\$ old_img_vfy = F\$Environment(\"VERIFY_IMAGE\")\n";
350   print DRVR "\$ MCR $^X -e \"\$ENV{'LIBPERL_RDT'} = (stat('$libperl'))[9]\"\n";
351   print DRVR "\$ Set Verify\n";
352   print DRVR "\$ If F\$Search(\"$libperl\").eqs.\"\" Then Library/Object/Create $libperl\n";
353   do {
354     push(@symfiles,"perlshr_gbl$marord");
355     print DRVR "\$ Macro/NoDebug/Object=PerlShr_Gbl${marord}$objsuffix PerlShr_Gbl$marord.Mar\n";
356     print DRVR "\$ Library/Object/Replace/Log $libperl PerlShr_Gbl${marord}$objsuffix\n";
357   } while (--$marord); 
358   # We had to have a working miniperl to run this program; it's probably the
359   # one we just built.  It depended on LibPerl, which will be changed when
360   # the PerlShr_Gbl* modules get inserted, so miniperl will be out of date,
361   # and so, therefore, will all of its dependents . . .
362   # We touch LibPerl here so it'll be back 'in date', and we won't rebuild
363   # miniperl etc., and therefore LibPerl, the next time we invoke MM[KS].
364   print DRVR "\$ old_proc_vfy = F\$Verify(old_proc_vfy,old_img_vfy)\n";
365   print DRVR "\$ MCR $^X -e \"utime 0, \$ENV{'LIBPERL_RDT'}, '$libperl'\"\n";
366   close DRVR;
367 }
368
369 # Initial hack to permit building of compatible shareable images for a
370 # given version of Perl.
371 if ($ENV{PERLSHR_USE_GSMATCH}) {
372   my $major = int($] * 1000)                        & 0xFF;  # range 0..255
373   my $minor = int(($] * 1000 - $major) * 100 + 0.5) & 0xFF;  # range 0..255
374   print OPTBLD "GSMATCH=LEQUAL,$major,$minor\n";
375   foreach (@symfiles) {
376     print OPTBLD "CLUSTER=\$\$TRANSFER_VECTOR,,,$_.$objsuffix\n";
377   }
378 }
379 elsif (@symfiles) { $incstr .= ',' . join(',',@symfiles); }
380 # Include object modules and RTLs in options file
381 # Linker wants /Include and /Library on different lines
382 print OPTBLD "$libperl/Include=($incstr)\n";
383 print OPTBLD "$libperl/Library\n";
384 open(RTLOPT,$rtlopt) or die "$0: Can't read options file $rtlopt: $!\n";
385 while (<RTLOPT>) { print OPTBLD; }
386 close RTLOPT;
387 close OPTBLD;
388
389 exec "\$ \@$drvrname" if $isvax;
390
391
392 __END__
393
394 # Oddball cases, so we can keep the perl.h scan above simple
395 rcsid=vars      # declared in perl.c
396 regarglen=vars  # declared in regcomp.h
397 regdummy=vars   # declared in regcomp.h
398 regkind=vars    # declared in regcomp.h
399 simple=vars     # declared in regcomp.h
400 varies=vars     # declared in regcomp.h
401 watchaddr=vars  # declared in run.c
402 watchok=vars    # declared in run.c
403 yychar=vars     # generated by byacc in perly.c
404 yycheck=vars    # generated by byacc in perly.c
405 yydebug=vars    # generated by byacc in perly.c
406 yydefred=vars   # generated by byacc in perly.c
407 yydgoto=vars    # generated by byacc in perly.c
408 yyerrflag=vars  # generated by byacc in perly.c
409 yygindex=vars   # generated by byacc in perly.c
410 yylen=vars      # generated by byacc in perly.c
411 yylhs=vars      # generated by byacc in perly.c
412 yylval=vars     # generated by byacc in perly.c
413 yyname=vars     # generated by byacc in perly.c
414 yynerrs=vars    # generated by byacc in perly.c
415 yyrindex=vars   # generated by byacc in perly.c
416 yyrule=vars     # generated by byacc in perly.c
417 yysindex=vars   # generated by byacc in perly.c
418 yytable=vars    # generated by byacc in perly.c
419 yyval=vars      # generated by byacc in perly.c