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-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   # 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     $debugging_enabled = $defines =~ /\bDEBUGGING\b/;
  72     @defines = split(/,/,$defines);
  73     $cc_cmd = "$prefix/Define=(" . join(',',grep($_ = "\"$_\"",@defines))
  74               . ')' . $suffix;
  75   }
  76   print "Filtered \$cc_cmd: \\$cc_cmd\\\n" if $debug;
  77
  78   # check for gcc - if present, we'll need to use MACRO hack to
  79   # define global symbols for shared variables
  80   $isvaxc = 0;
  81   $isgcc = `$cc_cmd _nla0:/Version` =~ /GNU/
  82            or 0; # make debug output nice
  83   $isvaxc = (!$isgcc && $isvax &&
  84              # Check exit status too, in case message is shut off
  85              (`$cc_cmd /prefix=all _nla0:` =~ /IVQUAL/ || $? == 0x38240))
  86             or 0; # again, make debug output nice
  87   print "\$isgcc: $isgcc\n" if $debug;
  88   print "\$isvaxc: $isvaxc\n" if $debug;
  89   print "\$debugging_enabled: $debugging_enabled\n" if $debug;
  90
  91   if (-f 'perl.h') { $dir = '[]'; }
  92   elsif (-f '[-]perl.h') { $dir = '[-]'; }
  93   else { die "$0: Can't find perl.h\n"; }
  94 }
  95 else {
  96   ($junk,$junk,$cpp_file,$cc_cmd) = split(/~~/,$cc_cmd,4);
  97   $isgcc = $cc_cmd =~ /case_hack/i
  98            or 0;  # for nice debug output
  99   $isvaxc = (!$isgcc && $cc_cmd !~ /standard=/i)
 100             or 0;  # again, for nice debug output
 101   $debugging_enabled = $cc_cmd =~ /\bdebugging\b/i;
 102   print "\$isgcc: \\$isgcc\\\n" if $debug;
 103   print "\$isvaxc: \\$isvaxc\\\n" if $debug;
 104   print "\$debugging_enabled: \\$debugging_enabled\\\n" if $debug;
 105   print "Not running cc, preprocesor output in \\$cpp_file\\\n" if $debug;
 106 }
 107
 108 $objsuffix = shift @ARGV;
 109 print "\$objsuffix: \\$objsuffix\\\n" if $debug;
 110 $dbgprefix = shift @ARGV;
 111 print "\$dbgprefix: \\$dbgprefix\\\n" if $debug;
 112 $olbsuffix = shift @ARGV;
 113 print "\$olbsuffix: \\$olbsuffix\\\n" if $debug;
 114 $libperl = "${dbgprefix}libperl$olbsuffix";
 115 $extnames = shift @ARGV;
 116 print "\$extnames: \\$extnames\\\n" if $debug;
 117 $rtlopt = shift @ARGV;
 118 print "\$rtlopt: \\$rtlopt\\\n" if $debug;
 119
 120 # This part gets tricky.  VAXC creates global symbols for each of the
 121 # constants in an enum if that enum is ever used as the data type of a
 122 # global[dr]ef.  We have to detect enums which are used in this way, so we
 123 # can set up the constants as universal symbols, since anything which
 124 # #includes perl.h will want to resolve these global symbols.
 125 # We're using a weak test here - we basically know that the only enums
 126 # we need to handle now are the big one in opcode.h, and the
 127 # "typedef enum { ... } expectation" in perl.h, so we hard code
 128 # appropriate tests below. Since we can't know in general whether a given
 129 # enum will be used elsewhere in a globaldef, it's hard to decide a
 130 # priori whether its constants need to be treated as global symbols.
 131 sub scan_enum {
 132   my($line) = @_;
 133
 134   return unless $isvaxc;
 135
 136   return unless /^\s+(OP|X)/;  # we only want opcode and expectation enums
 137   print "\tchecking for enum constant\n" if $debug > 1;
 138   $line =~ s#/\*.+##;
 139   $line =~ s/,?\s*\n?$//;
 140   print "\tfiltered to \\$line\\\n" if $debug > 1;
 141   if ($line =~ /(\w+)$/) {
 142     print "\tconstant name is \\$1\\\n" if $debug > 1;
 143     $enums{$1}++;
 144   }
 145 }
 146
 147 sub scan_var {
 148   my($line) = @_;
 149   my($const) = $line =~ /^EXTCONST/;
 150
 151   print "\tchecking for global variable\n" if $debug > 1;
 152   $line =~ s/\s*EXT/EXT/;
 153   $line =~ s/INIT\s*\(.*\)//;
 154   $line =~ s/\[.*//;
 155   $line =~ s/=.*//;
 156   $line =~ s/\W*;?\s*$//;
 157   $line =~ s/\W*\)\s*\(.*$//; # closing paren for args stripped in previous stmt
 158   print "\tfiltered to \\$line\\\n" if $debug > 1;
 159   if ($line =~ /(\w+)$/) {
 160     print "\tvar name is \\$1\\" . ($const ? ' (const)' : '') . "\n" if $debug > 1;
 161    if ($const) { $cvars{$1}++; }
 162    else        { $vars{$1}++;  }
 163   }
 164   if ($isvaxc) {
 165     my($type) = $line =~ /^\s*EXT\w*\s+(\w+)/;
 166     print "\tchecking for use of enum (type is \"$type\")\n" if $debug > 2;
 167     if ($type eq 'expectation') {
 168       $used_expectation_enum++;
 169       print "\tsaw global use of enum \"expectation\"\n" if $debug > 1;
 170     }
 171     if ($type eq 'opcode') {
 172       $used_opcode_enum++;
 173       print "\tsaw global use of enum \"opcode\"\n" if $debug > 1;
 174     }
 175   }
 176 }
 177
 178 sub scan_func {
 179   my($line) = @_;
 180
 181   print "\tchecking for global routine\n" if $debug > 1;
 182   if ( $line =~ /(\w+)\s+\(/ ) {
 183     print "\troutine name is \\$1\\\n" if $debug > 1;
 184     if ($1 eq 'main' || $1 eq 'perl_init_ext') {
 185       print "\tskipped\n" if $debug > 1;
 186     }
 187     else { $fcns{$1}++ }
 188   }
 189 }
 190
 191 $used_expectation_enum = $used_opcode_enum = 0; # avoid warnings
 192 if ($docc) {
 193   open(CPP,"${cc_cmd}/NoObj/PreProc=Sys\$Output ${dir}perl.h|")
 194     or die "$0: Can't preprocess ${dir}perl.h: $!\n";
 195 }
 196 else {
 197   open(CPP,"$cpp_file") or die "$0: Can't read preprocessed file $cpp_file: $!\n";
 198 }
 199 %checkh = map { $_,1 } qw( thread bytecode byterun proto );
 200 $ckfunc = 0;
 201 LINE: while (<CPP>) {
 202   while (/^#.*vmsish\.h/i .. /^#.*perl\.h/i) {
 203     while (/__VMS_PROTOTYPES__/i .. /__VMS_SEPYTOTORP__/i) {
 204       print "vms_proto>> $_" if $debug > 2;
 205       if (/^\s*EXT/) { &scan_var($_);  }
 206       else        { &scan_func($_); }
 207       last LINE unless defined($_ = <CPP>);
 208     }
 209     print "vmsish.h>> $_" if $debug > 2;
 210     if (/^\s*EXT/) { &scan_var($_); }
 211     last LINE unless defined($_ = <CPP>);
 212   }
 213   while (/^#.*opcode\.h/i .. /^#.*perl\.h/i) {
 214     print "opcode.h>> $_" if $debug > 2;
 215     if (/^OP \*\s/) { &scan_func($_); }
 216     if (/^\s*EXT/) { &scan_var($_); }
 217     if (/^\s+OP_/) { &scan_enum($_); }
 218     last LINE unless defined($_ = <CPP>);
 219   }
 220   while (/^typedef enum/ .. /^\s*\}/) {
 221     print "global enum>> $_" if $debug > 2;
 222     &scan_enum($_);
 223     last LINE unless defined($_ = <CPP>);
 224   }
 225   # Check for transition to new header file
 226   if (/^# \d+ "(\S+)"/) {
 227     my $spec = $1;
 228     # Pull name from library module or header filespec
 229     $spec =~ /^(\w+)$/ or $spec =~ /(\w+)\.h/i;
 230     my $name = lc $1;
 231     $ckfunc = exists $checkh{$name} ? 1 : 0;
 232     $scanname = $name if $ckfunc;
 233     print "Header file transition: ckfunc = $ckfunc for $name.h\n" if $debug > 1;
 234   }
 235   if ($ckfunc) {
 236     print "$scanname>> $_" if $debug > 2;
 237     if (/\s*^EXT/) { &scan_var($_);  }
 238     else           { &scan_func($_); }
 239   }
 240   else {
 241     print $_ if $debug > 3 && ($debug > 5 || length($_));
 242     if (/^\s*EXT/) { &scan_var($_); }
 243   }
 244 }
 245 close CPP;
 246
 247
 248 # Kluge to determine whether we need to add EMBED prefix to
 249 # symbols read from local list.  vmsreaddirversions() is a VMS-
 250 # specific function whose Perl_ prefix is added in vmsish.h
 251 # if EMBED is #defined.
 252 $embed = exists($fcns{'Perl_vmsreaddirversions'}) ? 'Perl_' : '';
 253 while (<DATA>) {
 254   next if /^#/;
 255   s/\s+#.*\n//;
 256   next if /^\s*$/;
 257   ($key,$array) = split('=',$_);
 258   $key = "$embed$key";
 259   print "Adding $key to \%$array list\n" if $debug > 1;
 260   ${$array}{$key}++;
 261 }
 262 if ($debugging_enabled and ($isvaxc or $isgcc)) { $vars{'colors'}++ }
 263 foreach (split /\s+/, $extnames) {
 264   my($pkgname) = $_;
 265   $pkgname =~ s/::/__/g;
 266   $fcns{"boot_$pkgname"}++;
 267   print "Adding boot_$pkgname to \%fcns (for extension $_)\n" if $debug;
 268 }
 269
 270 # If we're using VAXC, fold in the names of the constants for enums
 271 # we've seen as the type of global vars.
 272 if ($isvaxc) {
 273   foreach (keys %enums) {
 274     if (/^OP/) {
 275       $vars{$_}++ if $used_opcode_enum;
 276       next;
 277     }
 278     if (/^X/) {
 279       $vars{$_}++ if $used_expectation_enum;
 280       next;
 281     }
 282     print STDERR "Unrecognized enum constant \"$_\" ignored\n";
 283   }
 284 }
 285 elsif ($isgcc) {
 286   # gcc creates this as a SHR,WRT psect in globals.c, but we
 287   # don't see it in the perl.h scan, since it's only declared
 288   # if DOINIT is #defined.  Bleah.  It's cheaper to just add
 289   # it by hand than to add /Define=DOINIT to the preprocessing
 290   # run and wade through all the extra junk.
 291   $vars{"${embed}Error"}++;
 292 }
 293
 294 # Eventually, we'll check against existing copies here, so we can add new
 295 # symbols to an existing options file in an upwardly-compatible manner.
 296
 297 $marord++;
 298 open(OPTBLD,">${dir}${dbgprefix}perlshr_bld.opt")
 299   or die "$0: Can't write to ${dir}${dbgprefix}perlshr_bld.opt: $!\n";
 300 if ($isvax) {
 301   open(MAR,">${dir}perlshr_gbl${marord}.mar")
 302     or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
 303   print MAR "\t.title perlshr_gbl$marord\n";
 304 }
 305 unless ($isgcc) {
 306   print OPTBLD "PSECT_ATTR=\$GLOBAL_RO_VARS,PIC,NOEXE,RD,NOWRT,SHR\n";
 307   print OPTBLD "PSECT_ATTR=\$GLOBAL_RW_VARS,PIC,NOEXE,RD,WRT,NOSHR\n";
 308 }
 309 foreach $var (sort (keys %vars,keys %cvars)) {
 310   if ($isvax) { print OPTBLD "UNIVERSAL=$var\n"; }
 311   else { print OPTBLD "SYMBOL_VECTOR=($var=DATA)\n"; }
 312   # This hack brought to you by the lack of a globaldef in gcc.
 313   if ($isgcc) {
 314     if ($count++ > 200) {  # max 254 psects/file
 315       print MAR "\t.end\n";
 316       close MAR;
 317       $marord++;
 318       open(MAR,">${dir}perlshr_gbl${marord}.mar")
 319         or die "$0: Can't write to ${dir}perlshr_gbl${marord}.mar: $!\n";
 320       print MAR "\t.title perlshr_gbl$marord\n";
 321       $count = 0;
 322     }
 323     print MAR "\t.psect ${var},long,pic,ovr,rd,wrt,noexe,noshr\n";
 324     print MAR "\t${var}::       .blkl 1\n";
 325   }
 326 }
 327
 328 print MAR "\t.psect \$transfer_vec,pic,rd,nowrt,exe,shr\n" if ($isvax);
 329 foreach $func (sort keys %fcns) {
 330   if ($isvax) {
 331     print MAR "\t.transfer $func\n";
 332     print MAR "\t.mask $func\n";
 333     print MAR "\tjmp G\^${func}+2\n";
 334   }
 335   else { print OPTBLD "SYMBOL_VECTOR=($func=PROCEDURE)\n"; }
 336 }
 337 if ($isvax) {
 338   print MAR "\t.end\n";
 339   close MAR;
 340 }
 341
 342 open(OPTATTR,">${dir}perlshr_attr.opt")
 343   or die "$0: Can't write to ${dir}perlshr_attr.opt: $!\n";
 344 if ($isvaxc) {
 345   print OPTATTR "PSECT_ATTR=\$CHAR_STRING_CONSTANTS,PIC,SHR,NOEXE,RD,NOWRT\n";
 346 }
 347 elsif ($isgcc) {
 348   foreach $var (sort keys %cvars) {
 349     print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,NOWRT,SHR\n";
 350   }
 351   foreach $var (sort keys %vars) {
 352     print OPTATTR "PSECT_ATTR=${var},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
 353   }
 354 }
 355 else {
 356   print OPTATTR "! No additional linker directives are needed when using DECC\n";
 357 }
 358 close OPTATTR;
 359
 360 $incstr = 'perl,globals';
 361 if ($isvax) {
 362   $drvrname = "Compile_shrmars.tmp_".time;
 363   open (DRVR,">$drvrname") or die "$0: Can't write to $drvrname: $!\n";
 364   print DRVR "\$ Set NoOn\n";
 365   print DRVR "\$ Delete/NoLog/NoConfirm $drvrname;\n";
 366   print DRVR "\$ old_proc_vfy = F\$Environment(\"VERIFY_PROCEDURE\")\n";
 367   print DRVR "\$ old_img_vfy = F\$Environment(\"VERIFY_IMAGE\")\n";
 368   print DRVR "\$ MCR $^X -e \"\$ENV{'LIBPERL_RDT'} = (stat('$libperl'))[9]\"\n";
 369   print DRVR "\$ Set Verify\n";
 370   print DRVR "\$ If F\$Search(\"$libperl\").eqs.\"\" Then Library/Object/Create $libperl\n";
 371   do {
 372     push(@symfiles,"perlshr_gbl$marord");
 373     print DRVR "\$ Macro/NoDebug/Object=PerlShr_Gbl${marord}$objsuffix PerlShr_Gbl$marord.Mar\n";
 374     print DRVR "\$ Library/Object/Replace/Log $libperl PerlShr_Gbl${marord}$objsuffix\n";
 375   } while (--$marord);
 376   # We had to have a working miniperl to run this program; it's probably the
 377   # one we just built.  It depended on LibPerl, which will be changed when
 378   # the PerlShr_Gbl* modules get inserted, so miniperl will be out of date,
 379   # and so, therefore, will all of its dependents . . .
 380   # We touch LibPerl here so it'll be back 'in date', and we won't rebuild
 381   # miniperl etc., and therefore LibPerl, the next time we invoke MM[KS].
 382   print DRVR "\$ old_proc_vfy = F\$Verify(old_proc_vfy,old_img_vfy)\n";
 383   print DRVR "\$ MCR $^X -e \"utime 0, \$ENV{'LIBPERL_RDT'}, '$libperl'\"\n";
 384   close DRVR;
 385 }
 386
 387 # Initial hack to permit building of compatible shareable images for a
 388 # given version of Perl.
 389 if ($ENV{PERLSHR_USE_GSMATCH}) {
 390   my $major = int($] * 1000)                        & 0xFF;  # range 0..255
 391   my $minor = int(($] * 1000 - $major) * 100 + 0.5) & 0xFF;  # range 0..255
 392   print OPTBLD "GSMATCH=LEQUAL,$major,$minor\n";
 393   print OPTBLD 'CLUSTER=$$TRANSFER_VECTOR,,',
 394                map(",$_$objsuffix",@symfiles), "\n";
 395 }
 396 elsif (@symfiles) { $incstr .= ',' . join(',',@symfiles); }
 397 # Include object modules and RTLs in options file
 398 # Linker wants /Include and /Library on different lines
 399 print OPTBLD "$libperl/Include=($incstr)\n";
 400 print OPTBLD "$libperl/Library\n";
 401 open(RTLOPT,$rtlopt) or die "$0: Can't read options file $rtlopt: $!\n";
 402 while (<RTLOPT>) { print OPTBLD; }
 403 close RTLOPT;
 404 close OPTBLD;
 405
 406 exec "\$ \@$drvrname" if $isvax;
 407
 408
 409 __END__
 410
 411 # Oddball cases, so we can keep the perl.h scan above simple
 412 rcsid=vars      # declared in perl.c
 413 regkind=vars    # declared in regcomp.h
 414 simple=vars     # declared in regcomp.h
 415 varies=vars     # declared in regcomp.h
 416 watchaddr=vars  # declared in run.c
 417 watchok=vars    # declared in run.c
 418 yychar=vars     # generated by byacc in perly.c
 419 yycheck=vars    # generated by byacc in perly.c
 420 yydebug=vars    # generated by byacc in perly.c
 421 yydefred=vars   # generated by byacc in perly.c
 422 yydgoto=vars    # generated by byacc in perly.c
 423 yyerrflag=vars  # generated by byacc in perly.c
 424 yygindex=vars   # generated by byacc in perly.c
 425 yylen=vars      # generated by byacc in perly.c
 426 yylhs=vars      # generated by byacc in perly.c
 427 yylval=vars     # generated by byacc in perly.c
 428 yyname=vars     # generated by byacc in perly.c
 429 yynerrs=vars    # generated by byacc in perly.c
 430 yyrindex=vars   # generated by byacc in perly.c
 431 yyrule=vars     # generated by byacc in perly.c
 432 yysindex=vars   # generated by byacc in perly.c
 433 yytable=vars    # generated by byacc in perly.c
 434 yyval=vars      # generated by byacc in perly.c