2 # The perl script requires the following variables to be bound
3 # to something meaningful before it will operate correctly:
10 # * a program to run (1st arg)
11 # * some "command-line opts" ( -O<opt1> -O<opt2> ... )
12 # [default: anything on the cmd line this script doesn't recognise ]
13 # the first opt not starting w/ "-" is taken to be an input
14 # file and (if it exists) is grepped for "what's going on here"
16 # * a file to feed to stdin ( -i<file> ) [default: /dev/null ]
17 # * a "time" command to use (-t <cmd>).
19 # * alternatively, a "-script <script>" argument says: run the
20 # named Bourne-shell script to do the test. It's passed the
21 # pgm-to-run as the one-and-only arg.
23 # Run the program with those options and that input, and check:
26 # * an expected exit status ( -x <val> ) [ default 0 ]
27 # * expected output on stdout ( -o1 <file> ) [ default /dev/null ]
28 # ( we'll accept one of several...)
29 # * expected output on stderr ( -o2 <file> ) [ default /dev/null ]
30 # ( we'll accept one of several...)
32 # (if the expected-output files' names end in .Z, then
33 # they are uncompressed before doing the comparison)
35 # (This is supposed to be a "prettier" replacement for runstdtest.)
39 # -accept-output replace output files with the ones actually generated by running
42 ($Pgm = $0) =~ s|.*/||;
52 $PgmStdinFile = '/dev/null';
53 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
54 $TmpPrefix = $ENV{'TMPDIR'};
56 $TmpPrefix ="$DEFAULT_TMPDIR";
57 $ENV{'TMPDIR'} = "$DEFAULT_TMPDIR"; # set the env var as well
59 # If this is Cygwin, ignore eol and CR characters.
60 # Perhaps required for MSYS too, although the cygpath
61 # bit is hopefully unnecessary.
62 if ( `uname | grep CYGWIN` ) {
63 $CONTEXT_DIFF=$CONTEXT_DIFF . " --strip-trailing-cr" ;
64 $TmpPrefix = `cygpath -m $TmpPrefix | tr -d \\\\n`;
66 $ScriptFile = "$TmpPrefix/run_me$$";
67 $DefaultStdoutFile = "$TmpPrefix/no_stdout$$"; # can't use /dev/null (e.g. Alphas)
68 $DefaultStderrFile = "$TmpPrefix/no_stderr$$";
74 $StatsFile = "$TmpPrefix/stats$$";
75 $CachegrindStats = "cachegrind.out.summary";
76 $SysSpecificTiming = '';
79 die "$Pgm: program to run not given as first argument\n" if $#ARGV < 0;
80 $ToRun = $ARGV[0]; shift(@ARGV);
81 # avoid picking up same-named thing from somewhere else on $PATH...
82 $ToRun = "./$ToRun" if -e "./$ToRun";
84 arg: while ($_ = $ARGV[0]) {
87 /^--$/ && do { # let anything past after --
88 push(@PgmArgs, @ARGV);
91 /^-v$/ && do { $Verbose = 1; next arg; };
92 /^-accept-output-stderr$/ && do { $SaveStderr = 1; next arg; };
93 /^-accept-output-stdout$/ && do { $SaveStdout = 1; next arg; };
94 /^-accept-output$/ && do { $SaveStdout = 1; $SaveStderr = 1; next arg; };
96 /^-stdout-binary/ && do { $StdoutBinary=1; next arg; };
97 /^-stdout-binary/ && do { $StderrBinary=1; next arg; };
99 /^-O(.*)/ && do { push(@PgmArgs, &grab_arg_arg('-O',$1)); next arg; };
100 /^-i(.*)/ && do { $PgmStdinFile = &grab_arg_arg('-i',$1);
102 print STDERR "$Pgm: bogus -i input file: $PgmStdinFile\n"
103 if $PgmStdinFile !~ /^\/dev\/.*$/ && ! -f $PgmStdinFile;
105 /^-fail/ && do { $PgmFail=1; next arg; };
106 /^-x(.*)/ && do { $PgmExitStatus = &grab_arg_arg('-x',$1);
108 print STDERR "$Pgm: bogus -x expected exit status: $PgmExitStatus\n"
109 if $PgmExitStatus !~ /^\d+$/;
111 /^-o1(.*)/ && do { $out_file = &grab_arg_arg('-o1',$1);
112 push(@PgmStdoutFile, $out_file);
114 /^-o2(.*)/ && do { $out_file = &grab_arg_arg('-o2',$1);
115 push(@PgmStderrFile, $out_file);
117 /^-prescript(.*)/ && do { $PreScript = &grab_arg_arg('-prescript',$1);
119 /^-postscript(.*)/ && do { $PostScript = &grab_arg_arg('-postscript',$1);
121 /^-script/ && do { print STDERR "$Pgm: -script argument is obsolete;\nUse -prescript and -postscript instead.\n";
124 /^-(ghc|hbc)-timing$/ && do { $SysSpecificTiming = $1;
126 /^-cachegrind$/ && do { $SysSpecificTiming = 'ghc-instrs';
129 /^-t(.*)/ && do { $TimeCmd = &grab_arg_arg('-t', $1); next arg; };
131 # anything else is taken to be a pgm arg
135 foreach $out_file ( @PgmStdoutFile ) {
136 if ( ! -f $out_file && !$SaveStdout ) {
137 print STDERR "$Pgm: warning: expected-stdout file missing: $out_file\n";
142 foreach $out_file ( @PgmStderrFile ) {
143 if ( ! -f $out_file && !$SaveStderr ) {
144 print STDERR "$Pgm: warning: expected-stderr file missing: $out_file\n";
151 # add on defaults if none specified
152 @PgmStdoutFile = ( $DefaultStdoutFile ) if $#PgmStdoutFile < 0;
153 @PgmStderrFile = ( $DefaultStderrFile ) if $#PgmStderrFile < 0;
155 # tidy up the pgm args:
156 # (1) look for the "first input file"
157 # and grep it for "interesting" comments (-- !!! )
158 # (2) quote any args w/ whitespace in them.
160 foreach $a ( @PgmArgs ) {
161 if (! $grep_done && $a !~ /^-/ && -f $a) {
162 print `egrep "^--[ ]?!!!" $a`;
165 if ($a =~ /\s/ || $a =~ /'/) {
166 $a =~ s/'/\\'/g; # backslash the quotes;
167 $a = "\"$a\""; # quote the arg
171 # deal with system-specific timing options
173 if ( $SysSpecificTiming =~ /^ghc/ ) {
174 $TimingMagic = "+RTS -S$StatsFile -RTS"
175 } elsif ( $SysSpecificTiming eq 'hbc' ) {
176 $TimingMagic = "-S$StatsFile";
179 if ($PreScript ne '') {
181 $PreScriptLines = `cat $PreScript`;
182 $PreScriptLines =~ s/\r//g;
184 $PreScriptLines = '';
187 if ($PostScript ne '') {
189 $PostScriptLines = `cat $PostScript`;
190 $PostScriptLines =~ s/\r//g;
192 $PostScriptLines =~ s#\$o1#$TmpPrefix/runtest$$.1#g;
193 $PostScriptLines =~ s#\$o2#$TmpPrefix/runtest$$.2#g;
195 $PostScriptLines = '';
198 # OK, so we're gonna do the normal thing...
200 if ($Cachegrind eq 'yes') {
201 $CachegrindPrefix = "valgrind --tool=cachegrind --log-fd=9 9>$CachegrindStats";
203 $CachegrindPrefix = '';
206 $Script = <<EOSCRIPT;
210 rm -f $DefaultStdoutFile $DefaultStderrFile
211 cat /dev/null > $DefaultStdoutFile
212 cat /dev/null > $DefaultStderrFile
215 $TimeCmd /bin/sh -c \'$CachegrindPrefix $ToRun $TimingMagic @PgmArgs < $PgmStdinFile 1> $TmpPrefix/runtest$$.1.raw 2> $TmpPrefix/runtest$$.2.raw 3> $TmpPrefix/runtest$$.3.raw\'
216 if [ "$StdoutBinary" = "0" ]; then
217 dos2unix < $TmpPrefix/runtest$$.1.raw > $TmpPrefix/runtest$$.1
219 cp $TmpPrefix/runtest$$.1.raw $TmpPrefix/runtest$$.1
221 if [ "$StderrBinary" = "0" ]; then
222 dos2unix < $TmpPrefix/runtest$$.2.raw > $TmpPrefix/runtest$$.2
224 cp $TmpPrefix/runtest$$.2.raw $TmpPrefix/runtest$$.2
226 dos2unix < $TmpPrefix/runtest$$.3.raw > $TmpPrefix/runtest$$.3
228 if [ \$progexit -eq 0 ] && [ $PgmFail -ne 0 ]; then
229 echo $ToRun @PgmArgs \\< $PgmStdinFile
230 echo "****" expected a failure, but was successful
233 if [ \$progexit -ne $PgmExitStatus ] && [ $PgmFail -eq 0 ]; then
234 echo $ToRun @PgmArgs \\< $PgmStdinFile
235 echo "****" expected exit status $PgmExitStatus not seen \\; got \$progexit
240 for out_file in @PgmStdoutFile ; do
241 if sed "s/\\r\$//" $TmpPrefix/runtest$$.1 | cmp -s \$out_file - ; then
245 if [ \$hit = 'NO' ] ; then
246 echo $ToRun @PgmArgs \\< $PgmStdinFile
247 echo expected stdout not matched by reality
248 orig_file="$PgmStdoutFile[0]";
249 [ ! -f \$orig_file ] && orig_file="/dev/null"
250 ${CONTEXT_DIFF} \$orig_file $TmpPrefix/runtest$$.1
254 if [ $SaveStdout = 1 ] &&
255 [ $PgmStdoutFile[0] != $DefaultStdoutFile ] && [ -s $TmpPrefix/runtest$$.1 ]; then
256 echo Saving away stdout output in $PgmStdoutFile[0] ...
257 if [ -f $PgmStdoutFile[0] ]; then
258 rm -f $PgmStdoutFile[0].bak
259 cp $PgmStdoutFile[0] $PgmStdoutFile[0].bak
261 cp $TmpPrefix/runtest$$.1 $PgmStdoutFile[0]
266 for out_file in @PgmStderrFile ; do
267 if sed "s/\\r\$//" $TmpPrefix/runtest$$.2 | cmp -s \$out_file - ; then
271 if [ \$hit = 'NO' ] ; then
272 echo $ToRun @PgmArgs \\< $PgmStdinFile
273 echo expected stderr not matched by reality
274 orig_file="$PgmStderrFile[0]"
275 [ ! -f \$orig_file ] && orig_file="/dev/null"
276 ${CONTEXT_DIFF} \$orig_file $TmpPrefix/runtest$$.2
280 if [ $SaveStderr = 1 ] &&
281 [ $PgmStderrFile[0] != $DefaultStderrFile ] && [ -s $TmpPrefix/runtest$$.2 ]; then
282 echo Saving away stderr output in $PgmStderrFile[0] ...
283 if [ -f $PgmStderrFile[0] ]; then
284 rm -f $PgmStderrFile[0].bak
285 cp $PgmStderrFile[0] $PgmStderrFile[0].bak
287 cp $TmpPrefix/runtest$$.2 $PgmStderrFile[0]
290 ${RM} core $ToRunOrig.spix $DefaultStdoutFile $DefaultStderrFile $TmpPrefix/runtest$$.1 $TmpPrefix/runtest$$.2 $TmpPrefix/runtest$$.3 $TmpPrefix/runtest$$.1.raw $TmpPrefix/runtest$$.2.raw $TmpPrefix/runtest$$.3.raw
294 # bung script into a file
295 open(SCR, "> $ScriptFile") || die "Failed opening script file $ScriptFile!\n";
297 close(SCR) || die "Failed closing script file!\n";
298 chmod 0755, $ScriptFile;
300 print STDERR $Script if $Verbose;
302 &run_something($ScriptFile);
304 if ( $SysSpecificTiming eq '' ) {
310 &process_stats_file();
311 &process_cachegrind_files() if $Cachegrind eq 'yes';
313 # print out what we found
314 print STDERR "<<$SysSpecificTiming: ";
315 if ( $Cachegrind ne 'yes') {
316 print STDERR "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $GCWork bytes GC work, ${TotMem}M in use, $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)";
318 print STDERR "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), $GCWork bytes GC work, ${TotMem}M in use, $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed), $TotInstrs instructions, $TotReads memory reads, $TotWrites memory writes, $TotMisses L2 cache misses";
320 print STDERR " :$SysSpecificTiming>>\n";
328 local($option, $rest_of_arg) = @_;
330 if ($rest_of_arg ne "") {
331 return($rest_of_arg);
332 } elsif ($#ARGV >= 0) {
333 local($temp) = $ARGV[0]; shift(@ARGV);
336 print STDERR "$Pgm: no argument following $option option\n";
342 local($str_to_do) = @_;
344 # print STDERR "$str_to_do\n" if $Verbose;
346 local($return_val) = 0;
350 if ($return_val != 0) {
351 #ToDo: this return-value mangling is wrong
352 # local($die_msg) = "$Pgm: execution of the $tidy_name had trouble";
353 # $die_msg .= " (program not found)" if $return_val == 255;
354 # $die_msg .= " ($!)" if $Verbose && $! != 0;
359 exit (($return_val == 0) ? 0 : 1);
363 sub process_stats_file {
365 # OK, process system-specific stats file
366 if ( $SysSpecificTiming =~ /^ghc/ ) {
368 #NB: nearly the same as in GHC driver's -ghc-timing stuff
370 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
372 local($max_live) = 0;
373 local($tot_live) = 0; # for calculating residency stuff
374 local($tot_samples) = 0;
378 if (! /Gen:\s+0/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
379 $max_live = $1 if $max_live < $1;
384 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
386 if (/^\s*([0-9,]+) bytes copied during GC/) {
392 # if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
393 # $MaxResidency = $1; $ResidencySamples = $2;
396 $GCs = $1 if /^\s*([0-9,]+) collections? in generation 0/;
398 if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
402 if ( /^\s*INIT\s+time\s*(-*\d+\.\d\d)s\s*\(\s*(-*\d+\.\d\d)s elapsed\)/ ) {
403 $InitTime = $1; $InitElapsed = $2;
404 } elsif ( /^\s*MUT\s+time\s*(-*\d+\.\d\d)s\s*\(\s*(-*\d+\.\d\d)s elapsed\)/ ) {
405 $MutTime = $1; $MutElapsed = $2;
406 } elsif ( /^\s*GC\s+time\s*(-*\d+\.\d\d)s\s*\(\s*(-*\d+\.\d\d)s elapsed\)/ ) {
407 $GcTime = $1; $GcElapsed = $2;
410 close(STATS) || die "Failed when closing $StatsFile\n";
411 if ( $tot_samples > 0 ) {
412 $ResidencySamples = $tot_samples;
413 $MaxResidency = $max_live;
414 $AvgResidency = int ($tot_live / $tot_samples) ;
417 } elsif ( $SysSpecificTiming eq 'hbc' ) {
419 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
421 $BytesAlloc = $1 if /^\s*([0-9]+) bytes allocated from the heap/;
423 $GCs = $1 if /^\s*([0-9]+) GCs?,$/;
425 if ( /^\s*(\d+\.\d\d) \((\d+\.\d)\) seconds total time,$/ ) {
426 $MutTime = $1; $MutElapsed = $2; # will fix up later
428 $InitTime = 0; $InitElapsed = 0; # hbc doesn't report these
430 } elsif ( /^\s*(\d+\.\d\d) \((\d+\.\d)\) seconds GC time/ ) {
431 $GcTime = $1; $GcElapsed = $2;
433 # fix up mutator time now
434 $MutTime = sprintf("%.2f", ($MutTime - $GcTime));
435 $MutElapsed = sprintf("%.1f", ($MutElapsed - $GcElapsed));
438 close(STATS) || die "Failed when closing $StatsFile\n";
441 # warn about what we didn't find
442 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
443 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
444 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
445 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
446 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
447 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
448 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
449 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
450 print STDERR "Warning: total memory not found in stats file\n" unless defined($TotMem);
451 print STDERR "Warning: GC work not found in stats file\n" unless defined($GCWork);
453 # things we didn't necessarily expect to find
454 $MaxResidency = 0 unless defined($MaxResidency);
455 $AvgResidency = 0 unless defined($AvgResidency);
456 $ResidencySamples = 0 unless defined($ResidencySamples);
459 $BytesAlloc =~ s/,//g;
460 $MaxResidency =~ s/,//g;
463 $InitElapsed =~ s/,//g;
465 $MutElapsed =~ s/,//g;
467 $GcElapsed =~ s/,//g;
470 sub process_cachegrind_files {
472 open(STATS, "< $CachegrindStats") || die("Can't open $CachegrindStats\n");
475 /^==\d+==\s+I\s+refs:\s+([0-9,]*)/ && do {
477 $TotInstrs =~ s/,//g;
480 /^==\d+==\s+D\s+refs:\s+[0-9,]+\s+\(([0-9,]+)\s+rd\s+\+\s+([0-9,]+)\s+wr/ && do {
484 $TotWrites =~ s/,//g;
487 /^==\d+==\s+L2d\s+misses:\s+([0-9,]+)/ && do {
489 $TotMisses =~ s/,//g;