2008-04-02 00:47:38 +04:00
|
|
|
#!/usr/bin/env perl
|
|
|
|
#
|
|
|
|
# The LLVM Compiler Infrastructure
|
|
|
|
#
|
|
|
|
# This file is distributed under the University of Illinois Open Source
|
|
|
|
# License. See LICENSE.TXT for details.
|
|
|
|
#
|
|
|
|
##===----------------------------------------------------------------------===##
|
|
|
|
#
|
|
|
|
# A script designed to wrap a build so that all calls to gcc are intercepted
|
|
|
|
# and piped to the static analyzer.
|
|
|
|
#
|
|
|
|
##===----------------------------------------------------------------------===##
|
|
|
|
|
|
|
|
use strict;
|
|
|
|
use warnings;
|
|
|
|
use File::Temp qw/ :mktemp /;
|
|
|
|
|
|
|
|
my $Verbose = 0; # Verbose output from this script.
|
|
|
|
my $Prog = "scan-build";
|
|
|
|
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
# GetHTMLRunDir - Construct an HTML directory name for the current run.
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
sub GetHTMLRunDir {
|
2008-04-02 00:47:38 +04:00
|
|
|
|
|
|
|
die "Not enough arguments." if (@_ == 0);
|
|
|
|
|
|
|
|
my $Dir = shift @_;
|
|
|
|
|
|
|
|
# Get current date and time.
|
|
|
|
|
|
|
|
my @CurrentTime = localtime();
|
|
|
|
|
|
|
|
my $year = $CurrentTime[5] + 1900;
|
|
|
|
my $day = $CurrentTime[3];
|
|
|
|
my $month = $CurrentTime[4] + 1;
|
|
|
|
|
|
|
|
my $DateString = "$year-$month-$day";
|
|
|
|
|
|
|
|
# Determine the run number.
|
|
|
|
|
|
|
|
my $RunNumber;
|
|
|
|
|
|
|
|
if (-d $Dir) {
|
|
|
|
|
|
|
|
if (! -r $Dir) {
|
2008-04-02 07:35:43 +04:00
|
|
|
die "error: '$Dir' exists but is not readable.\n";
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
# Iterate over all files in the specified directory.
|
|
|
|
|
|
|
|
my $max = 0;
|
|
|
|
|
|
|
|
opendir(DIR, $Dir);
|
|
|
|
my @FILES= readdir(DIR);
|
|
|
|
closedir(DIR);
|
|
|
|
|
|
|
|
foreach my $f (@FILES) {
|
|
|
|
|
|
|
|
my @x = split/-/, $f;
|
|
|
|
|
|
|
|
next if (scalar(@x) != 4);
|
|
|
|
next if ($x[0] != $year);
|
|
|
|
next if ($x[1] != $month);
|
|
|
|
next if ($x[2] != $day);
|
|
|
|
|
|
|
|
if ($x[3] > $max) {
|
|
|
|
$max = $x[3];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$RunNumber = $max + 1;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
|
|
|
|
if (-x $Dir) {
|
2008-04-02 07:35:43 +04:00
|
|
|
die "error: '$Dir' exists but is not a directory.\n";
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
# $Dir does not exist. It will be automatically created by the
|
|
|
|
# clang driver. Set the run number to 1.
|
|
|
|
|
|
|
|
$RunNumber = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
die "RunNumber must be defined!" if (!defined($RunNumber));
|
|
|
|
|
|
|
|
# Append the run number.
|
|
|
|
|
|
|
|
return "$Dir/$DateString-$RunNumber";
|
|
|
|
}
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
sub SetHtmlEnv {
|
2008-04-02 00:47:38 +04:00
|
|
|
|
|
|
|
die "Wrong number of arguments." if (scalar(@_) != 2);
|
|
|
|
|
|
|
|
my $Args = shift;
|
|
|
|
my $Dir = shift;
|
|
|
|
|
|
|
|
die "No build command." if (scalar(@$Args) == 0);
|
|
|
|
|
|
|
|
my $Cmd = $$Args[0];
|
|
|
|
|
|
|
|
if ($Cmd =~ /configure/) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($Verbose) {
|
|
|
|
print "$Prog: Emitting reports for this run to '$Dir'.\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
$ENV{'CCC_ANALYZER_HTML'} = $Dir;
|
|
|
|
}
|
|
|
|
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
# Postprocess - Postprocess the results of an analysis scan.
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
sub Postprocess {
|
2008-04-02 00:47:38 +04:00
|
|
|
|
|
|
|
my $Dir = shift;
|
|
|
|
|
|
|
|
die "No directory specified." if (!defined($Dir));
|
|
|
|
|
|
|
|
if (! -d $Dir) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
opendir(DIR, $Dir);
|
|
|
|
my @files = grep(/^report-.*\.html$/,readdir(DIR));
|
|
|
|
closedir(DIR);
|
|
|
|
|
|
|
|
if (scalar(@files) == 0) {
|
|
|
|
print "$Prog: Remove directory '$Dir' because it contains no reports.\n";
|
|
|
|
`rm -fR $Dir`;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
# DisplayHelp - Utility function to display all help options.
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
sub DisplayHelp {
|
2008-04-02 00:47:38 +04:00
|
|
|
|
2008-04-02 01:22:03 +04:00
|
|
|
print <<ENDTEXT
|
2008-04-02 07:35:43 +04:00
|
|
|
USAGE: $Prog [options] <build command> [build options]
|
2008-04-02 01:22:03 +04:00
|
|
|
|
|
|
|
OPTIONS:
|
|
|
|
|
|
|
|
-o - Target directory for HTML report files. Subdirectories
|
2008-04-02 07:35:43 +04:00
|
|
|
will be created as needed to represent separate "runs" of
|
2008-04-02 01:22:03 +04:00
|
|
|
the analyzer. If this option is not specified, a directory
|
|
|
|
is created in /tmp to store the reports.
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
-?, -h - Display this message.
|
2008-04-02 01:22:03 +04:00
|
|
|
--help
|
|
|
|
|
|
|
|
-k - Add "keep on going option" to the specified build command.
|
2008-04-02 07:35:43 +04:00
|
|
|
--keep-going This command currently supports "make" and "xcodebuild." You
|
|
|
|
can also directly specify the corresponding option to the
|
|
|
|
build command.
|
2008-04-02 01:22:03 +04:00
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
-v - Verbose output from $Prog and the analyzer. A second
|
2008-04-02 01:22:03 +04:00
|
|
|
"-v" increases verbosity.
|
|
|
|
|
|
|
|
|
|
|
|
BUILD OPTIONS
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
You can specify any build option acceptable to the build command. For
|
|
|
|
example:
|
2008-04-02 01:22:03 +04:00
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
$Prog -o /tmp/myhtmldir make -j4
|
2008-04-02 01:22:03 +04:00
|
|
|
|
|
|
|
The above causes analysis reports to be deposited in /tmp/myhtmldir (or
|
|
|
|
rather a subdirectory corresponding to this particular running of the
|
|
|
|
analyzer), and causes "make" to be run with the "-j4" option, allowing
|
|
|
|
parallel builds (and parallel invocations of the analyzer).
|
|
|
|
|
|
|
|
NOTE: The analyzer will work for most parallel builds, but not distributed
|
|
|
|
builds (such as using distcc).
|
|
|
|
|
|
|
|
ENDTEXT
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
# Process command-line arguments.
|
|
|
|
##----------------------------------------------------------------------------##
|
|
|
|
|
|
|
|
my $HtmlDir; # Parent directory to store HTML files.
|
|
|
|
my $IgnoreErrors = 0; # Ignore build errors.
|
|
|
|
|
|
|
|
if (!@ARGV) {
|
|
|
|
DisplayHelp();
|
2008-04-02 07:35:43 +04:00
|
|
|
exit 1;
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
while (@ARGV) {
|
|
|
|
|
|
|
|
# Scan for options we recognize.
|
|
|
|
|
|
|
|
my $arg = $ARGV[0];
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
if ($arg eq "-?" or $arg eq "-h" or $arg eq "--help") {
|
2008-04-02 00:47:38 +04:00
|
|
|
DisplayHelp();
|
2008-04-02 07:35:43 +04:00
|
|
|
exit 0;
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
if ($arg eq "-o") {
|
|
|
|
shift @ARGV;
|
|
|
|
|
|
|
|
if (!@ARGV) {
|
2008-04-02 07:35:43 +04:00
|
|
|
die "'-o' option requires a target directory name.";
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
$HtmlDir = shift @ARGV;
|
|
|
|
next;
|
|
|
|
}
|
|
|
|
|
2008-04-02 01:22:03 +04:00
|
|
|
if ($arg eq "-k" or $arg eq "--keep-going") {
|
2008-04-02 00:47:38 +04:00
|
|
|
shift @ARGV;
|
|
|
|
$IgnoreErrors = 1;
|
|
|
|
next;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($arg eq "-v") {
|
|
|
|
shift @ARGV;
|
|
|
|
$Verbose++;
|
|
|
|
next;
|
|
|
|
}
|
|
|
|
|
|
|
|
last;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!@ARGV) {
|
|
|
|
print STDERR "$Prog: No build command specified.\n\n";
|
|
|
|
DisplayHelp();
|
2008-04-02 07:35:43 +04:00
|
|
|
exit 1;
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
# Determine the output directory for the HTML reports.
|
|
|
|
|
|
|
|
if (!defined($HtmlDir)) {
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
$HtmlDir = mkdtemp("/tmp/$Prog-XXXXXX");
|
2008-04-02 00:47:38 +04:00
|
|
|
|
|
|
|
if (!defined($HtmlDir)) {
|
2008-04-02 07:35:43 +04:00
|
|
|
die "error: Cannot create HTML directory in /tmp.\n";
|
2008-04-02 00:47:38 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!$Verbose) {
|
|
|
|
print "$Prog: Using '$HtmlDir' as base HTML report directory.\n";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
$HtmlDir = GetHTMLRunDir($HtmlDir);
|
2008-04-02 00:47:38 +04:00
|
|
|
|
|
|
|
# Set the appropriate environment variables.
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
SetHtmlEnv(\@ARGV, $HtmlDir);
|
2008-04-02 00:47:38 +04:00
|
|
|
|
|
|
|
$ENV{'CC'} = "ccc-analyzer";
|
|
|
|
|
|
|
|
if ($Verbose >= 2) {
|
|
|
|
$ENV{'CCC_ANALYZER_VERBOSE'} = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
# Run the build.
|
|
|
|
|
|
|
|
system(@ARGV);
|
|
|
|
|
|
|
|
# Postprocess the HTML directory.
|
|
|
|
|
2008-04-02 07:35:43 +04:00
|
|
|
Postprocess($HtmlDir);
|