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|.*/||;
50 $PgmStdinFile = '/dev/null';
51 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
52 $TmpPrefix = $ENV{'TMPDIR'};
54 $TmpPrefix ="$DEFAULT_TMPDIR";
55 $ENV{'TMPDIR'} = "$DEFAULT_TMPDIR"; # set the env var as well
57 # If this is Cygwin, ignore eol and CR characters.
58 # Perhaps required for MSYS too, although the cygpath
59 # bit is hopefully unnecessary.
60 if ( `uname | grep CYGWIN` ) {
61 $CONTEXT_DIFF=$CONTEXT_DIFF . " --strip-trailing-cr" ;
62 $TmpPrefix = `cygpath -m $TmpPrefix | tr -d \\\\n`;
64 $ScriptFile = "$TmpPrefix/run_me$$";
65 $DefaultStdoutFile = "$TmpPrefix/no_stdout$$"; # can't use /dev/null (e.g. Alphas)
66 $DefaultStderrFile = "$TmpPrefix/no_stderr$$";
72 $StatsFile = "$TmpPrefix/stats$$";
73 $CachegrindStats = "cachegrind.out.summary";
74 $SysSpecificTiming = '';
77 die "$Pgm: program to run not given as first argument\n" if $#ARGV < 0;
78 $ToRun = $ARGV[0]; shift(@ARGV);
79 # avoid picking up same-named thing from somewhere else on $PATH...
80 $ToRun = "./$ToRun" if -e "./$ToRun";
82 arg: while ($_ = $ARGV[0]) {
85 /^--$/ && do { # let anything past after --
86 push(@PgmArgs, @ARGV);
89 /^-v$/ && do { $Verbose = 1; next arg; };
90 /^-accept-output-stderr$/ && do { $SaveStderr = 1; next arg; };
91 /^-accept-output-stdout$/ && do { $SaveStdout = 1; next arg; };
92 /^-accept-output$/ && do { $SaveStdout = 1; $SaveStderr = 1; next arg; };
94 /^-O(.*)/ && do { push(@PgmArgs, &grab_arg_arg('-O',$1)); next arg; };
95 /^-i(.*)/ && do { $PgmStdinFile = &grab_arg_arg('-i',$1);
97 print STDERR "$Pgm: bogus -i input file: $PgmStdinFile\n"
98 if $PgmStdinFile !~ /^\/dev\/.*$/ && ! -f $PgmStdinFile;
100 /^-fail/ && do { $PgmFail=1; next arg; };
101 /^-x(.*)/ && do { $PgmExitStatus = &grab_arg_arg('-x',$1);
103 print STDERR "$Pgm: bogus -x expected exit status: $PgmExitStatus\n"
104 if $PgmExitStatus !~ /^\d+$/;
106 /^-o1(.*)/ && do { $out_file = &grab_arg_arg('-o1',$1);
107 push(@PgmStdoutFile, $out_file);
109 /^-o2(.*)/ && do { $out_file = &grab_arg_arg('-o2',$1);
110 push(@PgmStderrFile, $out_file);
112 /^-prescript(.*)/ && do { $PreScript = &grab_arg_arg('-prescript',$1);
114 /^-postscript(.*)/ && do { $PostScript = &grab_arg_arg('-postscript',$1);
116 /^-script/ && do { print STDERR "$Pgm: -script argument is obsolete;\nUse -prescript and -postscript instead.\n";
119 /^-(ghc|hbc)-timing$/ && do { $SysSpecificTiming = $1;
121 /^-cachegrind$/ && do { $SysSpecificTiming = 'ghc-instrs';
124 /^-t(.*)/ && do { $TimeCmd = &grab_arg_arg('-t', $1); next arg; };
126 # anything else is taken to be a pgm arg
130 foreach $out_file ( @PgmStdoutFile ) {
131 if ( ! -f $out_file && !$SaveStdout ) {
132 print STDERR "$Pgm: warning: expected-stdout file missing: $out_file\n";
137 foreach $out_file ( @PgmStderrFile ) {
138 if ( ! -f $out_file && !$SaveStderr ) {
139 print STDERR "$Pgm: warning: expected-stderr file missing: $out_file\n";
146 # add on defaults if none specified
147 @PgmStdoutFile = ( $DefaultStdoutFile ) if $#PgmStdoutFile < 0;
148 @PgmStderrFile = ( $DefaultStderrFile ) if $#PgmStderrFile < 0;
150 # tidy up the pgm args:
151 # (1) look for the "first input file"
152 # and grep it for "interesting" comments (-- !!! )
153 # (2) quote any args w/ whitespace in them.
155 foreach $a ( @PgmArgs ) {
156 if (! $grep_done && $a !~ /^-/ && -f $a) {
157 print `egrep "^--[ ]?!!!" $a`;
160 if ($a =~ /\s/ || $a =~ /'/) {
161 $a =~ s/'/\\'/g; # backslash the quotes;
162 $a = "\"$a\""; # quote the arg
166 # deal with system-specific timing options
168 if ( $SysSpecificTiming =~ /^ghc/ ) {
169 $TimingMagic = "+RTS -S$StatsFile -RTS"
170 } elsif ( $SysSpecificTiming eq 'hbc' ) {
171 $TimingMagic = "-S$StatsFile";
174 if ($PreScript ne '') {
176 $PreScriptLines = `cat $PreScript`;
177 $PreScriptLines =~ s/\r//g;
179 $PreScriptLines = '';
182 if ($PostScript ne '') {
184 $PostScriptLines = `cat $PostScript`;
185 $PostScriptLines =~ s/\r//g;
187 $PostScriptLines =~ s#\$o1#$TmpPrefix/runtest$$.1#g;
188 $PostScriptLines =~ s#\$o2#$TmpPrefix/runtest$$.2#g;
190 $PostScriptLines = '';
193 # OK, so we're gonna do the normal thing...
195 if ($Cachegrind eq 'yes') {
196 $CachegrindPrefix = "valgrind --tool=cachegrind --log-fd=9 9>$CachegrindStats";
198 $CachegrindPrefix = '';
201 $Script = <<EOSCRIPT;
205 rm -f $DefaultStdoutFile $DefaultStderrFile
206 cat /dev/null > $DefaultStdoutFile
207 cat /dev/null > $DefaultStderrFile
211 $TimeCmd /bin/sh -c \'$CachegrindPrefix $ToRun $TimingMagic @PgmArgs < $PgmStdinFile 1> $TmpPrefix/runtest$$.1.raw 2> $TmpPrefix/runtest$$.2.raw 3> $TmpPrefix/runtest$$.3.raw\'
213 dos2unix < $TmpPrefix/runtest$$.1.raw > $TmpPrefix/runtest$$.1
214 dos2unix < $TmpPrefix/runtest$$.2.raw > $TmpPrefix/runtest$$.2
215 dos2unix < $TmpPrefix/runtest$$.3.raw > $TmpPrefix/runtest$$.3
217 if [ \$progexit -eq 0 ] && [ $PgmFail -ne 0 ]; then
218 echo $ToRun @PgmArgs \\< $PgmStdinFile
219 echo "****" expected a failure, but was successful
222 if [ \$progexit -ne $PgmExitStatus ] && [ $PgmFail -eq 0 ]; then
223 echo $ToRun @PgmArgs \\< $PgmStdinFile
224 echo "****" expected exit status $PgmExitStatus not seen \\; got \$progexit
229 for out_file in @PgmStdoutFile ; do
230 if sed "s/\\r\$//" $TmpPrefix/runtest$$.1 | cmp -s \$out_file - ; then
234 if [ \$hit = 'NO' ] ; then
235 echo $ToRun @PgmArgs \\< $PgmStdinFile
236 echo expected stdout not matched by reality
237 orig_file="$PgmStdoutFile[0]";
238 [ ! -f \$orig_file ] && orig_file="/dev/null"
239 ${CONTEXT_DIFF} \$orig_file $TmpPrefix/runtest$$.1
243 if [ $SaveStdout = 1 ] &&
244 [ $PgmStdoutFile[0] != $DefaultStdoutFile ] && [ -s $TmpPrefix/runtest$$.1 ]; then
245 echo Saving away stdout output in $PgmStdoutFile[0] ...
246 if [ -f $PgmStdoutFile[0] ]; then
247 rm -f $PgmStdoutFile[0].bak
248 cp $PgmStdoutFile[0] $PgmStdoutFile[0].bak
250 cp $TmpPrefix/runtest$$.1 $PgmStdoutFile[0]
255 for out_file in @PgmStderrFile ; do
256 if sed "s/\\r\$//" $TmpPrefix/runtest$$.2 | cmp -s \$out_file - ; then
260 if [ \$hit = 'NO' ] ; then
261 echo $ToRun @PgmArgs \\< $PgmStdinFile
262 echo expected stderr not matched by reality
263 orig_file="$PgmStderrFile[0]"
264 [ ! -f \$orig_file ] && orig_file="/dev/null"
265 ${CONTEXT_DIFF} \$orig_file $TmpPrefix/runtest$$.2
269 if [ $SaveStderr = 1 ] &&
270 [ $PgmStderrFile[0] != $DefaultStderrFile ] && [ -s $TmpPrefix/runtest$$.2 ]; then
271 echo Saving away stderr output in $PgmStderrFile[0] ...
272 if [ -f $PgmStderrFile[0] ]; then
273 rm -f $PgmStderrFile[0].bak
274 cp $PgmStderrFile[0] $PgmStderrFile[0].bak
276 cp $TmpPrefix/runtest$$.2 $PgmStderrFile[0]
279 ${RM} core $ToRunOrig.spix $DefaultStdoutFile $DefaultStderrFile $TmpPrefix/runtest$$.1 $TmpPrefix/runtest$$.2 $TmpPrefix/runtest$$.3
283 # bung script into a file
284 open(SCR, "> $ScriptFile") || die "Failed opening script file $ScriptFile!\n";
286 close(SCR) || die "Failed closing script file!\n";
287 chmod 0755, $ScriptFile;
289 print STDERR $Script if $Verbose;
291 &run_something($ScriptFile);
293 if ( $SysSpecificTiming eq '' ) {
299 &process_stats_file();
300 &process_cachegrind_files() if $Cachegrind eq 'yes';
302 # print out what we found
303 print STDERR "<<$SysSpecificTiming: ";
304 if ( $Cachegrind ne 'yes') {
305 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)";
307 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";
309 print STDERR " :$SysSpecificTiming>>\n";
317 local($option, $rest_of_arg) = @_;
319 if ($rest_of_arg ne "") {
320 return($rest_of_arg);
321 } elsif ($#ARGV >= 0) {
322 local($temp) = $ARGV[0]; shift(@ARGV);
325 print STDERR "$Pgm: no argument following $option option\n";
331 local($str_to_do) = @_;
333 # print STDERR "$str_to_do\n" if $Verbose;
335 local($return_val) = 0;
339 if ($return_val != 0) {
340 #ToDo: this return-value mangling is wrong
341 # local($die_msg) = "$Pgm: execution of the $tidy_name had trouble";
342 # $die_msg .= " (program not found)" if $return_val == 255;
343 # $die_msg .= " ($!)" if $Verbose && $! != 0;
348 exit (($return_val == 0) ? 0 : 1);
352 sub process_stats_file {
354 # OK, process system-specific stats file
355 if ( $SysSpecificTiming =~ /^ghc/ ) {
357 #NB: nearly the same as in GHC driver's -ghc-timing stuff
359 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
361 local($max_live) = 0;
362 local($tot_live) = 0; # for calculating residency stuff
363 local($tot_samples) = 0;
367 if (! /Gen:\s+0/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
368 $max_live = $1 if $max_live < $1;
373 $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
374 $GCWork += $1 if /^\s*([0-9,]+) bytes copied during GC/;
376 # if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
377 # $MaxResidency = $1; $ResidencySamples = $2;
380 $GCs = $1 if /^\s*([0-9,]+) collections? in generation 0/;
382 if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
386 if ( /^\s*INIT\s+time\s*(-*\d+\.\d\d)s\s*\(\s*(-*\d+\.\d\d)s elapsed\)/ ) {
387 $InitTime = $1; $InitElapsed = $2;
388 } elsif ( /^\s*MUT\s+time\s*(-*\d+\.\d\d)s\s*\(\s*(-*\d+\.\d\d)s elapsed\)/ ) {
389 $MutTime = $1; $MutElapsed = $2;
390 } elsif ( /^\s*GC\s+time\s*(-*\d+\.\d\d)s\s*\(\s*(-*\d+\.\d\d)s elapsed\)/ ) {
391 $GcTime = $1; $GcElapsed = $2;
394 close(STATS) || die "Failed when closing $StatsFile\n";
395 if ( $tot_samples > 0 ) {
396 $ResidencySamples = $tot_samples;
397 $MaxResidency = $max_live;
398 $AvgResidency = int ($tot_live / $tot_samples) ;
401 } elsif ( $SysSpecificTiming eq 'hbc' ) {
403 open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
405 $BytesAlloc = $1 if /^\s*([0-9]+) bytes allocated from the heap/;
407 $GCs = $1 if /^\s*([0-9]+) GCs?,$/;
409 if ( /^\s*(\d+\.\d\d) \((\d+\.\d)\) seconds total time,$/ ) {
410 $MutTime = $1; $MutElapsed = $2; # will fix up later
412 $InitTime = 0; $InitElapsed = 0; # hbc doesn't report these
414 } elsif ( /^\s*(\d+\.\d\d) \((\d+\.\d)\) seconds GC time/ ) {
415 $GcTime = $1; $GcElapsed = $2;
417 # fix up mutator time now
418 $MutTime = sprintf("%.2f", ($MutTime - $GcTime));
419 $MutElapsed = sprintf("%.1f", ($MutElapsed - $GcElapsed));
422 close(STATS) || die "Failed when closing $StatsFile\n";
425 # warn about what we didn't find
426 print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
427 print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
428 print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
429 print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
430 print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
431 print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
432 print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
433 print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
434 print STDERR "Warning: total memory not found in stats file\n" unless defined($TotMem);
435 print STDERR "Warning: GC work not found in stats file\n" unless defined($GCWork);
437 # things we didn't necessarily expect to find
438 $MaxResidency = 0 unless defined($MaxResidency);
439 $AvgResidency = 0 unless defined($AvgResidency);
440 $ResidencySamples = 0 unless defined($ResidencySamples);
443 $BytesAlloc =~ s/,//g;
445 $MaxResidency =~ s/,//g;
448 $InitElapsed =~ s/,//g;
450 $MutElapsed =~ s/,//g;
452 $GcElapsed =~ s/,//g;
455 sub process_cachegrind_files {
457 open(STATS, "< $CachegrindStats") || die("Can't open $CachegrindStats\n");
460 /^==\d+==\s+I\s+refs:\s+([0-9,]*)/ && do {
462 $TotInstrs =~ s/,//g;
465 /^==\d+==\s+D\s+refs:\s+[0-9,]+\s+\(([0-9,]+)\s+rd\s+\+\s+([0-9,]+)\s+wr/ && do {
469 $TotWrites =~ s/,//g;
472 /^==\d+==\s+L2d\s+misses:\s+([0-9,]+)/ && do {
474 $TotMisses =~ s/,//g;