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