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