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