Adding autoconf support to the sample project.
[oota-llvm.git] / utils / NightlyTest.pl
1 #!/usr/dcs/software/supported/bin/perl -w
2 #
3 # Program:  NightlyTest.pl
4 #
5 # Synopsis: Perform a series of tests which are designed to be run nightly.
6 #           This is used to keep track of the status of the LLVM tree, tracking
7 #           regressions and performance changes.  This generates one web page a
8 #           day which can be used to access this information.
9 #
10 # Syntax:   NightlyTest.pl [OPTIONS] [CVSROOT BUILDDIR WEBDIR]
11 #   where
12 # OPTIONS may include one or more of the following:
13 #  -nocheckout      Do not create, checkout, update, or configure
14 #                   the source tree.
15 #  -noremove        Do not remove the BUILDDIR after it has been built.
16 #  -notest          Do not even attempt to run the test programs. Implies
17 #                   -norunningtests.
18 #  -norunningtests  Do not run the Olden benchmark suite with
19 #                   LARGE_PROBLEM_SIZE enabled.
20 #  -parallel        Run two parallel jobs with GNU Make.
21 # CVSROOT is the CVS repository from which the tree will be checked out,
22 #  specified either in the full :method:user@host:/dir syntax, or
23 #  just /dir if using a local repo.
24 # BUILDDIR is the directory where sources for this test run will be checked out
25 #  AND objects for this test run will be built. This directory MUST NOT
26 #  exist before the script is run; it will be created by the cvs checkout
27 #  process and erased (unless -noremove is specified; see above.)
28 # WEBDIR is the directory into which the test results web page will be written,
29 #  AND in which the "index.html" is assumed to be a symlink to the most recent
30 #  copy of the results. This directory MUST exist before the script is run.
31 #
32 use POSIX qw(strftime);
33
34 my $HOME = $ENV{'HOME'};
35 my $CVSRootDir = $ENV{'CVSROOT'};
36    $CVSRootDir = "/home/vadve/shared/PublicCVS"
37     unless $CVSRootDir;
38 my $BuildDir   = "$HOME/buildtest";
39 my $WebDir     = "$HOME/cvs/testresults-X86";
40
41 # Calculate the date prefix...
42 @TIME = localtime;
43 my $DATE = sprintf "%4d-%02d-%02d", $TIME[5]+1900, $TIME[4]+1, $TIME[3];
44 my $DateString = strftime "%B %d, %Y", localtime;
45
46 sub ReadFile {
47   undef $/;
48   if (open (FILE, $_[0])) {
49     my $Ret = <FILE>;
50     close FILE;
51     return $Ret;
52   } else {
53     print "Could not open file '$_[0]' for reading!";
54     return "";
55   }
56 }
57
58 sub WriteFile {  # (filename, contents)
59   open (FILE, ">$_[0]") or die "Could not open file '$_[0]' for writing!";
60   print FILE $_[1];
61   close FILE;
62 }
63
64 sub GetRegex {   # (Regex with ()'s, value)
65   $_[1] =~ /$_[0]/m;
66   if (defined($1)) {
67     return $1;
68   }
69   return "?";
70 }
71
72 sub AddPreTag {  # Add pre tags around nonempty list, or convert to "none"
73   $_ = shift;
74   if (length) { return "<ul><pre>$_</pre></ul>"; } else { "<b>none</b><br>"; }
75 }
76
77 sub GetDir {
78   my $Suffix = shift;
79   opendir DH, $WebDir;
80   my @Result = reverse sort grep !/$DATE/, grep /[-0-9]+$Suffix/, readdir DH;
81   closedir DH;
82   return @Result;
83 }
84
85 # DiffFiles - Diff the current version of the file against the last version of
86 # the file, reporting things added and removed.  This is used to report, for
87 # example, added and removed warnings.  This returns a pair (added, removed)
88 #
89 sub DiffFiles {
90   my $Suffix = shift;
91   my @Others = GetDir $Suffix;
92   if (@Others == 0) {  # No other files?  We added all entries...
93     return (`cat $WebDir/$DATE$Suffix`, "");
94   }
95   # Diff the files now...
96   my @Diffs = split "\n", `diff $WebDir/$DATE$Suffix $WebDir/$Others[0]`;
97   my $Added   = join "\n", grep /^</, @Diffs;
98   my $Removed = join "\n", grep /^>/, @Diffs;
99   $Added =~ s/^< //gm;
100   $Removed =~ s/^> //gm;
101   return ($Added, $Removed);
102 }
103
104 # FormatTime - Convert a time from 1m23.45 into 83.45
105 sub FormatTime {
106   my $Time = shift;
107   if ($Time =~ m/([0-9]+)m([0-9.]+)/) {
108     $Time = sprintf("%7.4f", $1*60.0+$2);
109   }
110   return $Time;
111 }
112
113
114 # Command line argument settings...
115 my $NOCHECKOUT = 0;
116 my $NOREMOVE   = 0;
117 my $NOTEST     = 0;
118 my $NORUNNINGTESTS = 0;
119 my $MAKEOPTS   = "";
120
121
122 # Parse arguments...
123 while (scalar(@ARGV) and ($_ = $ARGV[0], /^[-+]/)) {
124   shift;
125   last if /^--$/;  # Stop processing arguments on --
126
127   # List command line options here...
128   if (/^-nocheckout$/)     { $NOCHECKOUT = 1; next; }
129   if (/^-noremove$/)       { $NOREMOVE   = 1; next; }
130   if (/^-notest$/)         { $NOTEST     = 1; $NORUNNINGTESTS = 1; next; }
131   if (/^-norunningtests$/) { $NORUNNINGTESTS = 1; next; }
132   if (/^-parallel$/)       { $MAKEOPTS   = "-j2 -l3.0"; next; }
133
134   print "Unknown option: $_ : ignoring!\n";
135 }
136
137 die "Must specify 0 or 3 options!" if (@ARGV != 0 and @ARGV != 3);
138
139 if (@ARGV == 3) {
140   $CVSRootDir = $ARGV[0];
141   $BuildDir   = $ARGV[1];
142   $WebDir     = $ARGV[2];
143 }
144
145 my $Template = "$BuildDir/llvm/utils/NightlyTestTemplate.html";
146 my $Prefix = "$WebDir/$DATE";
147
148 if (0) {
149   print "CVS Root = $CVSRootDir\n";
150   print "BuildDir = $BuildDir\n";
151   print "WebDir   = $WebDir\n";
152   print "Prefix   = $Prefix\n";
153 }
154
155
156 #
157 # Create the CVS repository directory
158 #
159 if (!$NOCHECKOUT) {
160   mkdir $BuildDir or die "Could not create CVS checkout directory $BuildDir!";
161 }
162 chdir $BuildDir or die "Could not change to CVS checkout directory $BuildDir!";
163
164
165 #
166 # Check out the llvm tree, saving CVS messages to the cvs log...
167 #
168 $CVSOPT = "";
169 $CVSOPT = "-z3" if $CVSRootDir =~ /^:ext:/; # Use compression if going over ssh.
170 system "(time -p cvs $CVSOPT -d $CVSRootDir co llvm) > $Prefix-CVS-Log.txt 2>&1"
171   if (!$NOCHECKOUT);
172
173 chdir "llvm" or die "Could not change into llvm directory!";
174
175 system "cvs up -P -d > /dev/null 2>&1" if (!$NOCHECKOUT);
176
177 # Read in the HTML template file...
178 my $TemplateContents = ReadFile $Template;
179
180
181 #
182 # Get some static statistics about the current state of CVS
183 #
184 my $CVSCheckoutTime = GetRegex "([0-9.]+)", `grep '^real' $Prefix-CVS-Log.txt`;
185 my $NumFilesInCVS = `grep '^U' $Prefix-CVS-Log.txt | wc -l` + 0;
186 my $NumDirsInCVS  = `grep '^cvs checkout' $Prefix-CVS-Log.txt | wc -l` + 0;
187 $LOC = GetRegex "([0-9]+) +total", `wc -l \`utils/getsrcs.sh\` | grep total`;
188
189 #
190 # Build the entire tree, saving build messages to the build log
191 #
192 if (!$NOCHECKOUT) {
193   system "(time -p ./configure --enable-jit --enable-spec --with-objroot=.) > $Prefix-Build-Log.txt 2>&1";
194
195   # Build the entire tree, capturing the output into $Prefix-Build-Log.txt
196   system "(time -p gmake $MAKEOPTS) >> $Prefix-Build-Log.txt 2>&1";
197 }
198
199
200 sub GetRegexNum {
201   my ($Regex, $Num, $Regex2, $File) = @_;
202   my @Items = split "\n", `grep '$Regex' $File`;
203   return GetRegex $Regex2, $Items[$Num];
204 }
205
206 #
207 # Get some statistics about the build...
208 #
209 my @Linked = split '\n', `grep Linking $Prefix-Build-Log.txt`;
210 my $NumExecutables = scalar(grep(/executable/, @Linked));
211 my $NumLibraries   = scalar(grep(!/executable/, @Linked));
212 my $NumObjects     = `grep '^Compiling' $Prefix-Build-Log.txt | wc -l` + 0;
213
214 my $ConfigTimeU = GetRegexNum "^user", 0, "([0-9.]+)", "$Prefix-Build-Log.txt";
215 my $ConfigTimeS = GetRegexNum "^sys", 0, "([0-9.]+)", "$Prefix-Build-Log.txt";
216 my $ConfigTime  = $ConfigTimeU+$ConfigTimeS;  # ConfigTime = User+System
217 my $ConfigWallTime = GetRegexNum "^real", 0,"([0-9.]+)","$Prefix-Build-Log.txt";
218
219 my $BuildTimeU = GetRegexNum "^user", 1, "([0-9.]+)", "$Prefix-Build-Log.txt";
220 my $BuildTimeS = GetRegexNum "^sys", 1, "([0-9.]+)", "$Prefix-Build-Log.txt";
221 my $BuildTime  = $BuildTimeU+$BuildTimeS;  # BuildTime = User+System
222 my $BuildWallTime = GetRegexNum "^real", 1, "([0-9.]+)","$Prefix-Build-Log.txt";
223
224 my $BuildError = "";
225 if (`grep '^gmake[^:]*: .*Error' $Prefix-Build-Log.txt | wc -l` + 0 ||
226     `grep '^gmake: \*\*\*.*Stop.' $Prefix-Build-Log.txt | wc -l`+0) {
227   $BuildError = "<h3><font color='red'>Build error: compilation " .
228                 "<a href=\"$DATE-Build-Log.txt\">aborted</a></font></h3>";
229 }
230
231 #
232 # Get warnings from the build
233 #
234 my @Warn = split "\n", `egrep 'warning:|Entering dir' $Prefix-Build-Log.txt`;
235 my @Warnings;
236 my $CurDir = "";
237
238 foreach $Warning (@Warn) {
239   if ($Warning =~ m/Entering directory \`([^\`]+)\'/) {
240     $CurDir = $1;                 # Keep track of directory warning is in...
241     if ($CurDir =~ m#$BuildDir/llvm/(.*)#) { # Remove buildir prefix if included
242       $CurDir = $1;
243     }
244   } else {
245     push @Warnings, "$CurDir/$Warning";     # Add directory to warning...
246   }
247 }
248 my $WarningsFile =  join "\n", @Warnings;
249 my $WarningsList = AddPreTag $WarningsFile;
250 $WarningsFile =~ s/:[0-9]+:/::/g;
251
252 # Emit the warnings file, so we can diff...
253 WriteFile "$WebDir/$DATE-Warnings.txt", $WarningsFile . "\n";
254 my ($WarningsAdded, $WarningsRemoved) = DiffFiles "-Warnings.txt";
255 $WarningsAdded = AddPreTag $WarningsAdded;
256 $WarningsRemoved = AddPreTag $WarningsRemoved;
257
258
259 #
260 # Get some statistics about CVS commits over the current day...
261 #
262 @CVSHistory = split "\n", `cvs history -D '1 day ago' -a -xAMROCGUW`;
263 #print join "\n", @CVSHistory; print "\n";
264
265 # Extract some information from the CVS history... use a hash so no duplicate
266 # stuff is stored.
267 my (%AddedFiles, %ModifiedFiles, %RemovedFiles, %UsersCommitted, %UsersUpdated);
268
269 my $DateRE = "[-:0-9 ]+\\+[0-9]+";
270
271 # Loop over every record from the CVS history, filling in the hashes.
272 foreach $File (@CVSHistory) {
273   my ($Type, $Date, $UID, $Rev, $Filename);
274   if ($File =~ /([AMRUGC]) ($DateRE) ([^ ]+) +([^ ]+) +([^ ]+) +([^ ]+)/) {
275     ($Type, $Date, $UID, $Rev, $Filename) = ($1, $2, $3, $4, "$6/$5");
276   } elsif ($File =~ /([W]) ($DateRE) ([^ ]+) +([^ ]+) +([^ ]+)/) {
277     ($Type, $Date, $UID, $Rev, $Filename) = ($1, $2, $3, $4, "$6/$5");
278   } elsif ($File =~ /([O]) ($DateRE) ([^ ]+) +([^ ]+)/) {
279     ($Type, $Date, $UID, $Rev, $Filename) = ($1, $2, $3, "", "$4/");
280   } else {
281     print "UNMATCHABLE: $File\n";
282   }
283   # print "$File\nTy = $Type Date = '$Date' UID=$UID Rev=$Rev File = '$Filename'\n";
284
285   if ($Filename =~ /^llvm/) {
286     if ($Type eq 'M') {        # Modified
287       $ModifiedFiles{$Filename} = 1;
288       $UsersCommitted{$UID} = 1;
289     } elsif ($Type eq 'A') {   # Added
290       $AddedFiles{$Filename} = 1;
291       $UsersCommitted{$UID} = 1;
292     } elsif ($Type eq 'R') {   # Removed
293       $RemovedFiles{$Filename} = 1;
294       $UsersCommitted{$UID} = 1;
295     } else {
296       $UsersUpdated{$UID} = 1;
297     }
298   }
299 }
300
301 my $UserCommitList = join "\n", keys %UsersCommitted;
302 my $UserUpdateList = join "\n", keys %UsersUpdated;
303 my $AddedFilesList = AddPreTag join "\n", sort keys %AddedFiles;
304 my $ModifiedFilesList = AddPreTag join "\n", sort keys %ModifiedFiles;
305 my $RemovedFilesList = AddPreTag join "\n", sort keys %RemovedFiles;
306
307 my $TestError = 1;
308 my $SingleSourceProgramsTable;
309 my $MultiSourceProgramsTable;
310 my $ExternalProgramsTable;
311
312
313 sub TestDirectory {
314   my $SubDir = shift;
315
316   chdir "test/Programs/$SubDir" or
317     die "Could not change into test/Programs/$SubDir testdir!";
318
319   # Run the programs tests... creating a report.nightly.html file
320   if (!$NOTEST) {
321     system "gmake $MAKEOPTS report.nightly.html TEST=nightly "
322          . "> $Prefix-$SubDir-ProgramTest.txt 2>&1";
323   } else {
324     system "gunzip $Prefix-$SubDir-ProgramTest.txt.gz";
325   }
326
327   my $ProgramsTable;
328   if (`grep '^gmake[^:]: .*Error' $Prefix-$SubDir-ProgramTest.txt | wc -l` + 0){
329     $TestError = 1;
330     $ProgramsTable = "<font color=white><h2>Error running tests!</h2></font>";
331   } elsif (`grep '^gmake[^:]: .*No rule to make target' $Prefix-$SubDir-ProgramTest.txt | wc -l` + 0) {
332     $TestError = 1;
333     $ProgramsTable =
334       "<font color=white><h2>Makefile error running tests!</h2></font>";
335   } else {
336     $TestError = 0;
337     $ProgramsTable = ReadFile "report.nightly.html";
338
339     #
340     # Create a list of the tests which were run...
341     #
342     system "egrep 'TEST-(PASS|FAIL)' < $Prefix-$SubDir-ProgramTest.txt "
343          . "| sort > $Prefix-$SubDir-Tests.txt";
344   }
345
346   # Compress the test output
347   system "gzip -f $Prefix-$SubDir-ProgramTest.txt";
348   chdir "../../.." or die "Cannot return to parent directory!";
349   return $ProgramsTable;
350 }
351
352 # If we build the tree successfully, run the nightly programs tests...
353 if ($BuildError eq "") {
354   $SingleSourceProgramsTable = TestDirectory("SingleSource");
355   $MultiSourceProgramsTable = TestDirectory("MultiSource");
356   $ExternalProgramsTable = TestDirectory("External");
357   system "cat $Prefix-SingleSource-Tests.txt $Prefix-MultiSource-Tests.txt ".
358          " $Prefix-External-Tests.txt | sort > $Prefix-Tests.txt";
359 }
360
361 my ($TestsAdded, $TestsRemoved, $TestsFixed, $TestsBroken) = ("","","","");
362
363 if ($TestError) {
364   $TestsAdded   = "<b>error testing</b><br>";
365   $TestsRemoved = "<b>error testing</b><br>";
366   $TestsFixed   = "<b>error testing</b><br>";
367   $TestsBroken  = "<b>error testing</b><br>";
368 } else {
369   my ($RTestsAdded, $RTestsRemoved) = DiffFiles "-Tests.txt";
370
371   my @RawTestsAddedArray = split '\n', $RTestsAdded;
372   my @RawTestsRemovedArray = split '\n', $RTestsRemoved;
373
374   my %OldTests = map {GetRegex('TEST-....: (.+)', $_)=>$_}
375     @RawTestsRemovedArray;
376   my %NewTests = map {GetRegex('TEST-....: (.+)', $_)=>$_}
377     @RawTestsAddedArray;
378
379   foreach $Test (keys %NewTests) {
380     if (!exists $OldTests{$Test}) {  # TestAdded if in New but not old
381       $TestsAdded = "$TestsAdded$Test\n";
382     } else {
383       if ($OldTests{$Test} =~ /TEST-PASS/) {  # Was the old one a pass?
384         $TestsBroken = "$TestsBroken$Test\n";  # New one must be a failure
385       } else {
386         $TestsFixed = "$TestsFixed$Test\n";    # No, new one is a pass.
387       }
388     }
389   }
390   foreach $Test (keys %OldTests) {  # TestRemoved if in Old but not New
391     $TestsRemoved = "$TestsRemoved$Test\n" if (!exists $NewTests{$Test});
392   }
393
394   $TestsAdded   = AddPreTag $TestsAdded;
395   $TestsRemoved = AddPreTag $TestsRemoved;
396   $TestsFixed   = AddPreTag $TestsFixed;
397   $TestsBroken  = AddPreTag $TestsBroken;
398 }
399
400 # If we built the tree successfully, runs of the Olden suite with
401 # LARGE_PROBLEM_SIZE on so that we can get some "running" statistics.
402 if ($BuildError eq "") {
403   my ($NATTime, $CBETime, $LLCTime, $JITTime, $OptTime, $BytecodeSize,
404       $MachCodeSize) = ("","","","","","","");
405   if (!$NORUNNINGTESTS) {
406     chdir "test/Programs/MultiSource/Benchmarks/Olden" or die "Olden tests moved?";
407
408     # Clean out previous results...
409     system "gmake $MAKEOPTS clean > /dev/null 2>&1";
410
411     # Run the nightly test in this directory, with LARGE_PROBLEM_SIZE enabled!
412     system "gmake $MAKEOPTS report.nightly.raw.out TEST=nightly " .
413            " LARGE_PROBLEM_SIZE=1 > /dev/null 2>&1";
414     system "cp report.nightly.raw.out $Prefix-Olden-tests.txt";
415   } else {
416     system "gunzip $Prefix-Olden-tests.txt.gz";
417   }
418
419   # Now we know we have $Prefix-Olden-tests.txt as the raw output file.  Split
420   # it up into records and read the useful information.
421   my @Records = split />>> ========= /, ReadFile "$Prefix-Olden-tests.txt";
422   shift @Records;  # Delete the first (garbage) record
423
424   # Loop over all of the records, summarizing them into rows for the running
425   # totals file.
426   my $WallTimeRE = "[A-Za-z0-9.: ]+\\(([0-9.]+) wall clock";
427   foreach $Rec (@Records) {
428     my $rNATTime = GetRegex 'TEST-RESULT-nat-time: real\s*([.0-9m]+)', $Rec;
429     my $rCBETime = GetRegex 'TEST-RESULT-cbe-time: real\s*([.0-9m]+)', $Rec;
430     my $rLLCTime = GetRegex 'TEST-RESULT-llc-time: real\s*([.0-9m]+)', $Rec;
431     my $rJITTime = GetRegex 'TEST-RESULT-jit-time: real\s*([.0-9m]+)', $Rec;
432     my $rOptTime = GetRegex "TEST-RESULT-compile: $WallTimeRE", $Rec;
433     my $rBytecodeSize = GetRegex 'TEST-RESULT-compile: *([0-9]+)', $Rec;
434     my $rMachCodeSize = GetRegex 'TEST-RESULT-jit-machcode: *([0-9]+).*bytes of machine code', $Rec;
435
436     $NATTime .= " " . FormatTime($rNATTime);
437     $CBETime .= " " . FormatTime($rCBETime);
438     $LLCTime .= " " . FormatTime($rLLCTime);
439     $JITTime .= " " . FormatTime($rJITTime);
440     $OptTime .= " $rOptTime";
441     $BytecodeSize .= " $rBytecodeSize";
442     $MachCodeSize .= " $rMachCodeSize";
443   }
444
445   # Now that we have all of the numbers we want, add them to the running totals
446   # files.
447   AddRecord($NATTime, "running_Olden_nat_time.txt");
448   AddRecord($CBETime, "running_Olden_cbe_time.txt");
449   AddRecord($LLCTime, "running_Olden_llc_time.txt");
450   AddRecord($JITTime, "running_Olden_jit_time.txt");
451   AddRecord($OptTime, "running_Olden_opt_time.txt");
452   AddRecord($BytecodeSize, "running_Olden_bytecode.txt");
453   AddRecord($MachCodeSize, "running_Olden_machcode.txt");
454
455   system "gzip -f $Prefix-Olden-tests.txt";
456 }
457
458
459
460
461 #
462 # Get a list of the previous days that we can link to...
463 #
464 my @PrevDays = map {s/.html//; $_} GetDir ".html";
465
466 splice @PrevDays, 20;  # Trim down list to something reasonable...
467
468 my $PrevDaysList =     # Format list for sidebar
469   join "\n  ", map { "<a href=\"$_.html\">$_</a><br>" } @PrevDays;
470
471 #
472 # Start outputing files into the web directory
473 #
474 chdir $WebDir or die "Could not change into web directory!";
475
476 # Add information to the files which accumulate information for graphs...
477 AddRecord($LOC, "running_loc.txt");
478 AddRecord($BuildTime, "running_build_time.txt");
479
480 #
481 # Rebuild the graphs now...
482 #
483 $GNUPLOT = "/usr/dcs/software/supported/bin/gnuplot";
484 $GNUPLOT = "gnuplot" if ! -x $GNUPLOT;
485 $PlotScriptFilename = "$BuildDir/llvm/utils/NightlyTest.gnuplot";
486 system ($GNUPLOT, $PlotScriptFilename);
487
488 #
489 # Remove the cvs tree...
490 #
491 system "rm -rf $BuildDir" if (!$NOCHECKOUT and !$NOREMOVE);
492
493 #
494 # Print out information...
495 #
496 if (0) {
497   print "DateString: $DateString\n";
498   print "CVS Checkout: $CVSCheckoutTime seconds\n";
499   print "Files/Dirs/LOC in CVS: $NumFilesInCVS/$NumDirsInCVS/$LOC\n";
500
501   print "Build Time: $BuildTime seconds\n";
502   print "Libraries/Executables/Objects built: $NumLibraries/$NumExecutables/$NumObjects\n";
503
504   print "WARNINGS:\n  $WarningsList\n";
505
506   print "Users committed: $UserCommitList\n";
507   print "Added Files: \n  $AddedFilesList\n";
508   print "Modified Files: \n  $ModifiedFilesList\n";
509   print "Removed Files: \n  $RemovedFilesList\n";
510
511   print "Previous Days =\n  $PrevDaysList\n";
512 }
513
514
515 #
516 # Output the files...
517 #
518
519 # Main HTML file...
520 my $Output;
521 eval "\$Output = <<ENDOFFILE;$TemplateContents\nENDOFFILE\n";
522 WriteFile "$DATE.html", $Output;
523
524 # Change the index.html symlink...
525 system "ln -sf $DATE.html index.html";
526
527 sub AddRecord {
528   my ($Val, $Filename) = @_;
529   my @Records;
530   if (open FILE, "$WebDir/$Filename") {
531     @Records = grep !/$DATE/, split "\n", <FILE>;
532     close FILE;
533   }
534   push @Records, "$DATE: $Val";
535   WriteFile "$WebDir/$Filename", (join "\n", @Records) . "\n";
536   return @Records;
537 }