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