4 # * a program to run (1st arg)
5 # * some "command-line opts" ( -O<opt1> -O<opt2> ... )
6 # [default: anything on the cmd line this script doesn't recognise ]
7 # the first opt not starting w/ "-" is taken to be an input
8 # file and (if it exists) is grepped for "what's going on here"
10 # * a file to feed to stdin ( -i<file> ) [default: /dev/null ]
11 # * a "time" command to use (-t <cmd>).
13 # * alternatively, a "-script <script>" argument says: run the
14 # named Bourne-shell script to do the test. It's passed the
15 # pgm-to-run as the one-and-only arg.
17 # Run the program with those options and that input, and check:
20 # * an expected exit status ( -x <val> ) [ default 0 ]
21 # * expected output on stdout ( -o1 <file> ) [ default /dev/null ]
22 # ( we'll accept one of several...)
23 # * expected output on stderr ( -o2 <file> ) [ default /dev/null ]
24 # ( we'll accept one of several...)
26 # (if the expected-output files' names end in .Z, then
27 # they are uncompressed before doing the comparison)
29 # (This is supposed to be a "prettier" replacement for runstdtest.)
31 ($Pgm = $0) =~ s|.*/||;
36 $PgmStdinFile = '/dev/null';
37 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
38 $TmpPrefix = $ENV{'TMPDIR'};
40 $TmpPrefix ="$(TMPDIR)";
41 $ENV{'TMPDIR'} = '$(TMPDIR)'; # set the env var as well
43 $ScriptFile = "$TmpPrefix/run_me$$";
44 $DefaultStdoutFile = "$TmpPrefix/no_stdout$$"; # can't use /dev/null (e.g. Alphas)
45 $DefaultStderrFile = "$TmpPrefix/no_stderr$$";
51 $StatsFile = "$TmpPrefix/stats$$";
52 $SysSpecificTiming = '';
55 die "$Pgm: program to run not given as first argument\n" if $#ARGV < 0;
56 $ToRun = $ARGV[0]; shift(@ARGV);
57 # avoid picking up same-named thing from somewhere else on $PATH...
58 $ToRun = "./$ToRun" if $ToRun !~ /^\//;
60 arg: while ($_ = $ARGV[0]) {
63 /^-v$/ && do { $Verbose = 1; next arg; };
64 /^-O(.*)/ && do { push(@PgmArgs, &grab_arg_arg('-O',$1)); next arg; };
65 /^-i(.*)/ && do { $PgmStdinFile = &grab_arg_arg('-i',$1);
67 print STDERR "$Pgm: bogus -i input file: $PgmStdinFile\n"
68 if ! -f $PgmStdinFile;
70 /^-x(.*)/ && do { $PgmExitStatus = &grab_arg_arg('-x',$1);
72 print STDERR "$Pgm: bogus -x expected exit status: $PgmExitStatus\n"
73 if $PgmExitStatus !~ /^\d+$/;
75 /^-o1(.*)/ && do { $out_file = &grab_arg_arg('-o1',$1);
76 push(@PgmStdoutFile, $out_file);
78 /^-o2(.*)/ && do { $out_file = &grab_arg_arg('-o2',$1);
79 push(@PgmStderrFile, $out_file);
81 /^-prescript(.*)/ && do { $PreScript = &grab_arg_arg('-prescript',$1);
83 /^-postscript(.*)/ && do { $PostScript = &grab_arg_arg('-postscript',$1);
85 /^-(ghc|hbc)-timing$/ && do { $SysSpecificTiming = $1;
87 /^-spix-timing$/ && do { $SysSpecificTiming = 'ghcspix';
90 /^-t(.*)/ && do { $TimeCmd = &grab_arg_arg('-t', $1); next arg; };
92 # anything else is taken to be a pgm arg
96 foreach $out_file ( @PgmStdoutFile ) {
98 print STDERR "$Pgm: bogus -o1 expected-output file: $out_file\n"
102 foreach $out_file ( @PgmStderrFile ) {
104 print STDERR "$Pgm: bogus -o2 expected-stderr file: $out_file\n"
110 # add on defaults if none specified
111 @PgmStdoutFile = ( $DefaultStdoutFile ) if $#PgmStdoutFile < 0;
112 @PgmStderrFile = ( $DefaultStderrFile ) if $#PgmStderrFile < 0;
114 # tidy up the pgm args:
115 # (1) look for the "first input file"
116 # and grep it for "interesting" comments (--!!! )
117 # (2) quote any args w/ whitespace in them.
119 foreach $a ( @PgmArgs ) {
120 if (! $grep_done && $a !~ /^-/ && -f $a) {
121 print `egrep "^--!!!" $a`;
124 if ($a =~ /\s/ || $a =~ /'/) {
125 $a =~ s/'/\\'/g; # backslash the quotes;
126 $a = "\"$a\""; # quote the arg
130 # deal with system-specific timing options
132 if ( $SysSpecificTiming =~ /^ghc/ ) {
133 $TimingMagic = "+RTS -s$StatsFile -RTS"
134 } elsif ( $SysSpecificTiming eq 'hbc' ) {
135 $TimingMagic = "-S$StatsFile";
139 if ( $SpixTiming eq 'yes' ) {
142 # gotta find first/last addresses in the mutator code
143 $FirstSpix = '_callWrapper';
144 $LastSpix = '???'; # usually _mpz_get_si, but can't be sure
146 open(SPIXNM, "nm -n $ToRunOrig |") || die "nm -n $ToRunOrig open failed!\n";
147 spix: while (<SPIXNM>) {
148 if ( / T (_FreeMallocPtr|_([A-Za-z]+)Hook|_xmalloc|_mpz_get_si)$/ ) {
153 close(SPIXNM); # || die "nm -n $ToRunOrig close failed!\n";
155 $SpixifyLine1 = "spix -o $ToRun -t$FirstSpix,$LastSpix $ToRunOrig";
156 $SpixstatsLine1 = "spixstats -b $TmpPrefix/runtest$$.3 $ToRunOrig > $ToRunOrig.spixstats1";
157 $SpixifyLine2 = "spix -o $ToRun +t$FirstSpix,$LastSpix $ToRunOrig";
158 $SpixstatsLine2 = "spixstats -b $TmpPrefix/runtest$$.3 $ToRunOrig > $ToRunOrig.spixstats2";
161 $SpixstatsLine1 = '';
163 $SpixstatsLine2 = '';
166 if ($PreScript ne '') {
168 $PreScriptLines = `cat $PreScript`;
170 $PreScriptLines = '';
173 if ($PostScript ne '') {
175 $PostScriptLines = `cat $PostScript`;
177 $PostScriptLines =~ s#\$o1#$TmpPrefix/runtest$$.1#g;
178 $PostScriptLines =~ s#\$o2#$TmpPrefix/runtest$$.2#g;
180 $PostScriptLines = '';
183 # OK, so we're gonna do the normal thing...
185 $Script = <<EOSCRIPT;
189 rm -f $DefaultStdoutFile $DefaultStderrFile
190 cat /dev/null > $DefaultStdoutFile
191 cat /dev/null > $DefaultStderrFile
194 $TimeCmd /bin/sh -c \'$ToRun $TimingMagic @PgmArgs < $PgmStdinFile 1> $TmpPrefix/runtest$$.1 2> $TmpPrefix/runtest$$.2 3> $TmpPrefix/runtest$$.3\'
196 if [ \$progexit -ne $PgmExitStatus ]; then
197 echo $ToRun @PgmArgs \\< $PgmStdinFile
198 echo expected exit status $PgmExitStatus not seen \\; got \$progexit
203 for out_file in @PgmStdoutFile ; do
204 if cmp -s \$out_file $TmpPrefix/runtest$$.1 ; then
208 if [ \$hit = 'NO' ] ; then
209 echo $ToRun @PgmArgs \\< $PgmStdinFile
210 echo expected stdout not matched by reality
211 $(CONTEXT_DIFF) $PgmStdoutFile[0] $TmpPrefix/runtest$$.1
216 egrep -v '^ld\.so:.*has older revision than expected' < $TmpPrefix/runtest$$.2 > $TmpPrefix/runtest$$.2b
217 mv -f $TmpPrefix/runtest$$.2b $TmpPrefix/runtest$$.2
220 for out_file in @PgmStderrFile ; do
221 if cmp -s \$out_file $TmpPrefix/runtest$$.2 ; then
225 if [ \$hit = 'NO' ] ; then
226 echo $ToRun @PgmArgs \\< $PgmStdinFile
227 echo expected stderr not matched by reality
228 $(CONTEXT_DIFF) $PgmStderrFile[0] $TmpPrefix/runtest$$.2
234 if [ $SpixTiming = 'yes' -a \$myexit = 0 ] ; then
236 $TimeCmd /bin/sh -c \'$ToRun $TimingMagic @PgmArgs < $PgmStdinFile 1> /dev/null 2> /dev/null 3> $TmpPrefix/runtest$$.3\'
240 $(RM) core $ToRunOrig.spix $DefaultStdoutFile $DefaultStderrFile $TmpPrefix/runtest$$.1 $TmpPrefix/runtest$$.2 $TmpPrefix/runtest$$.3
244 # bung script into a file
245 open(SCR, "> $ScriptFile") || die "Failed opening script file $ScriptFile!\n";
247 close(SCR) || die "Failed closing script file!\n";
248 chmod 0755, $ScriptFile;
250 print STDERR $Script if $Verbose;
252 &run_something($ScriptFile);
254 if ( $SysSpecificTiming eq '' ) {
260 &process_stats_file();
261 &process_spixstats_files() if $SpixTiming eq 'yes';
263 # print out what we found
264 if ( $SpixTiming ne 'yes' ) {
265 print STDERR "<<$SysSpecificTiming: ",
266 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
267 " :$SysSpecificTiming>>\n";
269 print STDERR "<<$SysSpecificTiming: ",
270 "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $TotalInsns[1]/$TotalInsns[2] instructions, $LoadInsns[1]/$LoadInsns[2] loads, $StoreInsns[1]/$StoreInsns[2] stores, $BranchInsns[1]/$BranchInsns[2] branches, $OtherInsns[1]/$OtherInsns[2] others",
271 " :$SysSpecificTiming>>\n";
280 local($option, $rest_of_arg) = @_;
283 return($rest_of_arg);
284 } elsif ($#ARGV >= 0) {
285 local($temp) = $ARGV[0]; shift(@ARGV);
288 print STDERR "$Pgm: no argument following $option option\n";
294 local($str_to_do) = @_;
296 # print STDERR "$str_to_do\n" if $Verbose;
298 local($return_val) = 0;
302 if ($return_val != 0) {
303 #ToDo: this return-value mangling is wrong
304 # local($die_msg) = "$Pgm: execution of the $tidy_name had trouble";
305 # $die_msg .= " (program not found)" if $return_val == 255;
306 # $die_msg .= " ($!)" if $Verbose && $! != 0;
311 exit (($return_val == 0) ? 0 : 1);
315 sub process_stats_file {
317 # OK, process system-specific stats file
318 if ( $SysSpecificTiming =~ /^ghc/ ) {
320 #NB: nearly the same as in GHC driver's -ghc-timing stuff
322 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
323 local($tot_live) = 0; # for calculating avg residency
326 $tot_live += $1 if /^\s*\d+\s+\d+\s+\d+\.\d+\%\s+(\d+)\s+\d+\.\d+\%/;
328 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
330 if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
331 $MaxResidency = $1; $ResidencySamples = $2;
334 $GCs = $1 if /^\s*([0-9,]+) garbage collections? performed/;
336 if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
337 $InitTime = $1; $InitElapsed = $2;
338 } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
339 $MutTime = $1; $MutElapsed = $2;
340 } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
341 $GcTime = $1; $GcElapsed = $2;
344 close(STATS) || die "Failed when closing $StatsFile\n";
345 if ( defined($ResidencySamples) && $ResidencySamples > 0 ) {
346 $AvgResidency = int ($tot_live / $ResidencySamples) ;
349 } elsif ( $SysSpecificTiming eq 'hbc' ) {
351 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
353 $BytesAlloc = $1 if /^\s*([0-9]+) bytes allocated from the heap/;
355 $GCs = $1 if /^\s*([0-9]+) GCs?,$/;
357 if ( /^\s*(\d+\.\d\d) \((\d+\.\d)\) seconds total time,$/ ) {
358 $MutTime = $1; $MutElapsed = $2; # will fix up later
360 $InitTime = 0; $InitElapsed = 0; # hbc doesn't report these
362 } elsif ( /^\s*(\d+\.\d\d) \((\d+\.\d)\) seconds GC time/ ) {
363 $GcTime = $1; $GcElapsed = $2;
365 # fix up mutator time now
366 $MutTime = sprintf("%.2f", ($MutTime - $GcTime));
367 $MutElapsed = sprintf("%.1f", ($MutElapsed - $GcElapsed));
370 close(STATS) || die "Failed when closing $StatsFile\n";
373 # warn about what we didn't find
374 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
375 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
376 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
377 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
378 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
379 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
380 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
381 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
383 # things we didn't necessarily expect to find
384 $MaxResidency = 0 unless defined($MaxResidency);
385 $AvgResidency = 0 unless defined($AvgResidency);
386 $ResidencySamples = 0 unless defined($ResidencySamples);
389 $BytesAlloc =~ s/,//g;
390 $MaxResidency =~ s/,//g;
393 $InitElapsed =~ s/,//g;
395 $MutElapsed =~ s/,//g;
397 $GcElapsed =~ s/,//g;
400 sub process_spixstats_files { # 2 of them; one for mutator, one for GC
410 open(STATS, "< $ToRunOrig.spixstats$f") || die "Failed when opening $ToRunOrig.spixstats$f\n";
412 last if /^OPCODES \(STATIC\):/; # party over
414 next if /^OPCODES \(DYNAMIC\):/;
416 next if /^opcode\s+#executed/;
419 if ( /^ld\S*\s+(\d+)/ ) {
420 $LoadInsns[$f] += $1;
422 } elsif ( /^st\S*\s+(\d+)/ ) {
423 $StoreInsns[$f] += $1;
425 } elsif ( /^(jmpl|call|b\S*)\s+(\d+)/ ) {
426 $BranchInsns[$f] += $2;
428 } elsif ( /^TOTAL\s+(\d+)/ ) {
429 $TotalInsns[$f] = $1;
430 print STDERR "TotalInsns doesn't match categories total!\n"
431 if $TotalInsns[$f] !=
432 ($LoadInsns[$f] + $StoreInsns[$f] + $BranchInsns[$f] + $OtherInsns[$f]);
434 } elsif ( /^\S+\s+(\d+)/ ) {
435 $OtherInsns[$f] += $1;
438 die "Funny line?? $_";
441 close(STATS) || die "Failed when closing $ToRunOrig.spixstats\n";