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