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