Re: [ID 20001023.003] PATCH perlfaq5 [perl-current]
[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@newman.upenn.edu
37
38 require 5.000;
39
40 $debug = $ENV{'GEN_SHRFLS_DEBUG'};
41
42 print "gen_shrfls.pl Rev. 14-Dec-1997\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   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 what is enabled in config.sh
72   $config = $dir . "config.sh";
73   open CONFIG, "< $config";
74   while(<CONFIG>) {
75     $use_threads++ if /usethreads='define'/;
76     $use_mymalloc++ if /usemymalloc='Y'/;
77     $care_about_case++ if /d_vms_case_sensitive_symbols='define'/;
78     $debugging_enabled++ if /usedebugging_perl='Y'/;
79     $hide_mymalloc++ if /embedmymalloc='Y'/;
80   }
81   close CONFIG;
82   
83   # put quotes back onto defines - they were removed by DCL on the way in
84   if (($prefix,$defines,$suffix) =
85          ($cc_cmd =~ m#(.*)/Define=(.*?)([/\s].*)#i)) {
86     $defines =~ s/^\((.*)\)$/$1/;
87     $debugging_enabled ||= $defines =~ /\bDEBUGGING\b/;
88     @defines = split(/,/,$defines);
89     $cc_cmd = "$prefix/Define=(" . join(',',grep($_ = "\"$_\"",@defines)) 
90               . ')' . $suffix;
91   }
92   print "Filtered \$cc_cmd: \\$cc_cmd\\\n" if $debug;
93
94   # check for gcc - if present, we'll need to use MACRO hack to
95   # define global symbols for shared variables
96   $isgcc = `$cc_cmd _nla0:/Version` =~ /GNU/
97            or 0; # make debug output nice
98   print "\$isgcc: $isgcc\n" if $debug;
99   print "\$debugging_enabled: $debugging_enabled\n" if $debug;
100
101 }
102 else { 
103   ($junk,$junk,$cpp_file,$cc_cmd) = split(/~~/,$cc_cmd,4);
104   $isgcc = $cc_cmd =~ /case_hack/i
105            or 0;  # for nice debug output
106   $debugging_enabled = $cc_cmd =~ /\bdebugging\b/i;
107   print "\$isgcc: \\$isgcc\\\n" if $debug;
108   print "\$debugging_enabled: \\$debugging_enabled\\\n" if $debug;
109   print "Not running cc, preprocesor output in \\$cpp_file\\\n" if $debug;
110 }
111
112 $objsuffix = shift @ARGV;
113 print "\$objsuffix: \\$objsuffix\\\n" if $debug;
114 $dbgprefix = shift @ARGV;
115 print "\$dbgprefix: \\$dbgprefix\\\n" if $debug;
116 $olbsuffix = shift @ARGV;
117 print "\$olbsuffix: \\$olbsuffix\\\n" if $debug;
118 $libperl = "${dbgprefix}libperl$olbsuffix";
119 $extnames = shift @ARGV;
120 print "\$extnames: \\$extnames\\\n" if $debug;
121 $rtlopt = shift @ARGV;
122 print "\$rtlopt: \\$rtlopt\\\n" if $debug;
123
124 sub scan_var {
125   my($line) = @_;
126   my($const) = $line =~ /^EXTCONST/;
127
128   print "\tchecking for global variable\n" if $debug > 1;
129   $line =~ s/\s*EXT/EXT/;
130   $line =~ s/INIT\s*\(.*\)//;
131   $line =~ s/\[.*//;
132   $line =~ s/=.*//;
133   $line =~ s/\W*;?\s*$//;
134   $line =~ s/\W*\)\s*\(.*$//; # closing paren for args stripped in previous stmt
135   print "\tfiltered to \\$line\\\n" if $debug > 1;
136   if ($line =~ /(\w+)$/) {
137     print "\tvar name is \\$1\\" . ($const ? ' (const)' : '') . "\n" if $debug > 1;
138    if ($const) { $cvars{$1}++; }
139    else        { $vars{$1}++;  }
140   }
141 }
142
143 sub scan_func {
144   my($line) = @_;
145
146   print "\tchecking for global routine\n" if $debug > 1;
147   if ( $line =~ /(\w+)\s*\(/ ) {
148     print "\troutine name is \\$1\\\n" if $debug > 1;
149     if ($1 eq 'main' || $1 eq 'perl_init_ext') {
150       print "\tskipped\n" if $debug > 1;
151     }
152     else { $fcns{$1}++ }
153   }
154 }
155
156 # Go add some right up front if we need 'em
157 if ($use_mymalloc) {
158   $fcns{'Perl_malloc'}++;
159   $fcns{'Perl_calloc'}++;
160   $fcns{'Perl_realloc'}++;
161   $fcns{'Perl_mfree'}++;
162 }
163
164 $used_expectation_enum = $used_opcode_enum = 0; # avoid warnings
165 if ($docc) {
166   open(CPP,"${cc_cmd}/NoObj/PreProc=Sys\$Output ${dir}perl.h|")
167     or die "$0: Can't preprocess ${dir}perl.h: $!\n";
168 }
169 else {
170   open(CPP,"$cpp_file") or die "$0: Can't read preprocessed file $cpp_file: $!\n";
171 }
172 %checkh = map { $_,1 } qw( thread bytecode byterun proto );
173 $ckfunc = 0;
174 LINE: while (<CPP>) {
175   while (/^#.*vmsish\.h/i .. /^#.*perl\.h/i) {
176     while (/__VMS_PROTOTYPES__/i .. /__VMS_SEPYTOTORP__/i) {
177       print "vms_proto>> $_" if $debug > 2;
178       if (/^\s*EXT/) { &scan_var($_);  }
179       else        { &scan_func($_); }
180       last LINE unless defined($_ = <CPP>);
181     }
182     print "vmsish.h>> $_" if $debug > 2;
183     if (/^\s*EXT/) { &scan_var($_); }
184     last LINE unless defined($_ = <CPP>);
185   }    
186   while (/^#.*opcode\.h/i .. /^#.*perl\.h/i) {
187     print "opcode.h>> $_" if $debug > 2;
188     if (/^OP \*\s/) { &scan_func($_); }
189     if (/^\s*EXT/) { &scan_var($_); }
190     last LINE unless defined($_ = <CPP>);
191   }
192   # Check for transition to new header file
193   if (/^# \d+ "(\S+)"/) {
194     my $spec = $1;
195     # Pull name from library module or header filespec
196     $spec =~ /^(\w+)$/ or $spec =~ /(\w+)\.h/i;
197     my $name = lc $1;
198     $ckfunc = exists $checkh{$name} ? 1 : 0;
199     $scanname = $name if $ckfunc;
200     print "Header file transition: ckfunc = $ckfunc for $name.h\n" if $debug > 1;
201   }
202   if ($ckfunc) {
203     print "$scanname>> $_" if $debug > 2;
204     if (/\s*^EXT/) { &scan_var($_);  }
205     else           { &scan_func($_); }
206   }
207   else {
208     print $_ if $debug > 3 && ($debug > 5 || length($_));
209     if (/^\s*EXT/) { &scan_var($_); }
210   }
211 }
212 close CPP;
213
214 while (<DATA>) {
215   next if /^#/;
216   s/\s+#.*\n//;
217   next if /^\s*$/;
218   ($key,$array) = split('=',$_);
219   if ($array eq 'vars') { $key = "PL_$key";   }
220   else                  { $key = "Perl_$key"; }
221   print "Adding $key to \%$array list\n" if $debug > 1;
222   ${$array}{$key}++;
223 }
224 if ($debugging_enabled and $isgcc) { $vars{'colors'}++ }
225 foreach (split /\s+/, $extnames) {
226   my($pkgname) = $_;
227   $pkgname =~ s/::/__/g;
228   $fcns{"boot_$pkgname"}++;
229   print "Adding boot_$pkgname to \%fcns (for extension $_)\n" if $debug;
230 }
231
232 # Eventually, we'll check against existing copies here, so we can add new
233 # symbols to an existing options file in an upwardly-compatible manner.
234
235 $marord++;
236 open(OPTBLD,">${dir}${dbgprefix}perlshr_bld.opt")
237   or die "$0: Can't write to ${dir}${dbgprefix}perlshr_bld.opt: $!\n";
238 if ($isvax) {
239   open(MAR,">${dir}perlshr_gbl${marord}.mar")
240     or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
241   print MAR "\t.title perlshr_gbl$marord\n";
242 }
243
244 unless ($isgcc) {
245   print OPTBLD "PSECT_ATTR=\$GLOBAL_RO_VARS,PIC,NOEXE,RD,NOWRT,SHR\n";
246   print OPTBLD "PSECT_ATTR=\$GLOBAL_RW_VARS,PIC,NOEXE,RD,WRT,NOSHR\n";
247 }
248 print OPTBLD "case_sensitive=yes\n" if $care_about_case;
249 foreach $var (sort (keys %vars,keys %cvars)) {
250   if ($isvax) { print OPTBLD "UNIVERSAL=$var\n"; }
251   else { print OPTBLD "SYMBOL_VECTOR=($var=DATA)\n"; }
252   # This hack brought to you by the lack of a globaldef in gcc.
253   if ($isgcc) {
254     if ($count++ > 200) {  # max 254 psects/file
255       print MAR "\t.end\n";
256       close MAR;
257       $marord++;
258       open(MAR,">${dir}perlshr_gbl${marord}.mar")
259         or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
260       print MAR "\t.title perlshr_gbl$marord\n";
261       $count = 0;
262     }
263     print MAR "\t.psect ${var},long,pic,ovr,rd,wrt,noexe,noshr\n";
264     print MAR "\t${var}::       .blkl 1\n";
265   }
266 }
267
268 print MAR "\t.psect \$transfer_vec,pic,rd,nowrt,exe,shr\n" if ($isvax);
269 foreach $func (sort keys %fcns) {
270   if ($isvax) {
271     print MAR "\t.transfer $func\n";
272     print MAR "\t.mask $func\n";
273     print MAR "\tjmp G\^${func}+2\n";
274   }
275   else { print OPTBLD "SYMBOL_VECTOR=($func=PROCEDURE)\n"; }
276 }
277 if ($isvax) {
278   print MAR "\t.end\n";
279   close MAR;
280 }
281
282 open(OPTATTR,">${dir}perlshr_attr.opt")
283   or die "$0: Can't write to ${dir}perlshr_attr.opt: $!\n";
284 if ($isgcc) {
285   foreach $var (sort keys %cvars) {
286     print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,NOWRT,SHR\n";
287   }
288   foreach $var (sort keys %vars) {
289     print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
290   }
291 }
292 else {
293   print OPTATTR "! No additional linker directives are needed when using DECC\n";
294 }
295 close OPTATTR;
296
297 $incstr = 'PERL,GLOBALS';
298 if ($isvax) {
299   $drvrname = "Compile_shrmars.tmp_".time;
300   open (DRVR,">$drvrname") or die "$0: Can't write to $drvrname: $!\n";
301   print DRVR "\$ Set NoOn\n";  
302   print DRVR "\$ Delete/NoLog/NoConfirm $drvrname;\n";
303   print DRVR "\$ old_proc_vfy = F\$Environment(\"VERIFY_PROCEDURE\")\n";
304   print DRVR "\$ old_img_vfy = F\$Environment(\"VERIFY_IMAGE\")\n";
305   print DRVR "\$ MCR $^X -e \"\$ENV{'LIBPERL_RDT'} = (stat('$libperl'))[9]\"\n";
306   print DRVR "\$ Set Verify\n";
307   print DRVR "\$ If F\$Search(\"$libperl\").eqs.\"\" Then Library/Object/Create $libperl\n";
308   do {
309     push(@symfiles,"perlshr_gbl$marord");
310     print DRVR "\$ Macro/NoDebug/Object=PerlShr_Gbl${marord}$objsuffix PerlShr_Gbl$marord.Mar\n";
311     print DRVR "\$ Library/Object/Replace/Log $libperl PerlShr_Gbl${marord}$objsuffix\n";
312   } while (--$marord); 
313   # We had to have a working miniperl to run this program; it's probably the
314   # one we just built.  It depended on LibPerl, which will be changed when
315   # the PerlShr_Gbl* modules get inserted, so miniperl will be out of date,
316   # and so, therefore, will all of its dependents . . .
317   # We touch LibPerl here so it'll be back 'in date', and we won't rebuild
318   # miniperl etc., and therefore LibPerl, the next time we invoke MM[KS].
319   print DRVR "\$ old_proc_vfy = F\$Verify(old_proc_vfy,old_img_vfy)\n";
320   print DRVR "\$ MCR $^X -e \"utime 0, \$ENV{'LIBPERL_RDT'}, '$libperl'\"\n";
321   close DRVR;
322 }
323
324 # Initial hack to permit building of compatible shareable images for a
325 # given version of Perl.
326 if ($ENV{PERLSHR_USE_GSMATCH}) {
327   if ($ENV{PERLSHR_USE_GSMATCH} eq 'INCLUDE_COMPILE_OPTIONS') {
328     # Build up a major ID. Since it can only be 8 bits, we encode the version
329     # number in the top four bits and use the bottom four for build options
330     # that'll cause incompatibilities
331     ($ver, $sub) = $] =~ /\.(\d\d\d)(\d\d)/;
332     $ver += 0; $sub += 0;
333     $gsmatch = ($sub >= 50) ? "equal" : "lequal"; # Force an equal match for
334                                                   # dev, but be more forgiving
335                                                   # for releases
336
337     $ver *=16;
338     $ver += 8 if $debugging_enabled;    # If DEBUGGING is set
339     $ver += 4 if $use_threads;          # if we're threaded
340     $ver += 2 if $use_mymalloc;         # if we're using perl's malloc
341     print OPTBLD "GSMATCH=$gsmatch,$ver,$sub\n";
342   }
343   else {
344     my $major = int($] * 1000)                        & 0xFF;  # range 0..255
345     my $minor = int(($] * 1000 - $major) * 100 + 0.5) & 0xFF;  # range 0..255
346     print OPTBLD "GSMATCH=LEQUAL,$major,$minor\n";
347   }
348   print OPTBLD 'CLUSTER=$$TRANSFER_VECTOR,,',
349                map(",$_$objsuffix",@symfiles), "\n";
350 }
351 elsif (@symfiles) { $incstr .= ',' . join(',',@symfiles); }
352 # Include object modules and RTLs in options file
353 # Linker wants /Include and /Library on different lines
354 print OPTBLD "$libperl/Include=($incstr)\n";
355 print OPTBLD "$libperl/Library\n";
356 open(RTLOPT,$rtlopt) or die "$0: Can't read options file $rtlopt: $!\n";
357 while (<RTLOPT>) { print OPTBLD; }
358 close RTLOPT;
359 close OPTBLD;
360
361 exec "\$ \@$drvrname" if $isvax;
362
363
364 __END__
365
366 # Oddball cases, so we can keep the perl.h scan above simple
367 regkind=vars    # declared in regcomp.h
368 simple=vars     # declared in regcomp.h
369 varies=vars     # declared in regcomp.h