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