blob: 0c89f0327adb8d0dbef4125bc5c4f516375d43eb [file] [log] [blame]
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001#!/usr/bin/env perl
2#
3# The LLVM Compiler Infrastructure
4#
5# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
7#
8##===----------------------------------------------------------------------===##
9#
10# A script designed to wrap a build so that all calls to gcc are intercepted
11# and piped to the static analyzer.
12#
13##===----------------------------------------------------------------------===##
14
15use strict;
16use warnings;
Ted Kremenek22d6a632008-04-02 20:43:36 +000017use FindBin qw($RealBin);
Ted Kremeneka6e24812008-04-19 18:05:48 +000018use Digest::MD5;
Ted Kremenek7a4648d2008-05-02 22:04:53 +000019use File::Basename;
Ted Kremenek23cfca32008-06-16 22:40:14 +000020use Term::ANSIColor;
21use Term::ANSIColor qw(:constants);
Ted Kremenek7cba1122008-09-22 01:35:58 +000022use Cwd;
23use Sys::Hostname;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +000024
25my $Verbose = 0; # Verbose output from this script.
26my $Prog = "scan-build";
Ted Kremenekf4cdf412008-05-23 18:17:05 +000027my $BuildName;
28my $BuildDate;
Ted Kremenek95aa1052008-09-04 17:52:41 +000029my $CXX; # Leave undefined initially.
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +000030
Ted Kremenek0e689382008-09-11 18:17:51 +000031my $TERM = $ENV{'TERM'};
32my $UseColor = (defined $TERM and $TERM eq 'xterm-color' and -t STDOUT
33 and defined $ENV{'SCAN_BUILD_COLOR'});
Ted Kremenek23cfca32008-06-16 22:40:14 +000034
Ted Kremenek7cba1122008-09-22 01:35:58 +000035my $UserName = HtmlEscape(getpwuid($<) || 'unknown');
36my $HostName = HtmlEscape(hostname() || 'unknown');
37my $CurrentDir = HtmlEscape(getcwd());
38my $CurrentDirSuffix = basename($CurrentDir);
39
40my $CmdArgs;
41
42my $HtmlTitle;
43
44my $Date = localtime();
45
Ted Kremenekb7770c02008-07-15 17:06:13 +000046##----------------------------------------------------------------------------##
47# Diagnostics
48##----------------------------------------------------------------------------##
49
Ted Kremenek23cfca32008-06-16 22:40:14 +000050sub Diag {
51 if ($UseColor) {
52 print BOLD, MAGENTA "$Prog: @_";
53 print RESET;
54 }
55 else {
56 print "$Prog: @_";
57 }
58}
59
Ted Kremenek991c54b2008-08-08 20:46:42 +000060sub DiagCrashes {
61 my $Dir = shift;
62 Diag ("The analyzer crashed on some source files.\n");
Ted Kremenek386c6932008-09-03 17:59:35 +000063 Diag ("Preprocessed versions of crashed files were deposited in '$Dir/crashes'.\n");
Ted Kremenek991c54b2008-08-08 20:46:42 +000064 Diag ("Please consider submitting a bug report using these files:\n");
65 Diag (" http://clang.llvm.org/StaticAnalysisUsage.html#filingbugs\n")
66}
67
Ted Kremenek23cfca32008-06-16 22:40:14 +000068sub DieDiag {
69 if ($UseColor) {
70 print BOLD, RED "$Prog: ";
71 print RESET, RED @_;
72 print RESET;
73 }
74 else {
75 print "$Prog: ", @_;
76 }
77 exit(0);
78}
79
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +000080##----------------------------------------------------------------------------##
Ted Kremenekb7770c02008-07-15 17:06:13 +000081# Some initial preprocessing of Clang options.
82##----------------------------------------------------------------------------##
83
Ted Kremeneke15fa272008-10-13 21:46:42 +000084my $ClangSB = Cwd::realpath("$RealBin/clang");
Ted Kremenekb7770c02008-07-15 17:06:13 +000085my $Clang = $ClangSB;
86
87if (! -x $ClangSB) {
88 $Clang = "clang";
89}
90
91my %AvailableAnalyses;
92
93# Query clang for analysis options.
Ted Kremenek63c20172008-08-04 17:34:06 +000094open(PIPE, "-|", $Clang, "--help") or
Ted Kremenek445fa772008-10-10 00:17:08 +000095 DieDiag("Cannot execute '$Clang'\n");
Ted Kremenek63c20172008-08-04 17:34:06 +000096
Ted Kremenekb7770c02008-07-15 17:06:13 +000097my $FoundAnalysis = 0;
98
99while(<PIPE>) {
100 if ($FoundAnalysis == 0) {
Ted Kremenekce1448b2008-10-24 15:11:58 +0000101 if (/SCA Checks\/Analyses/) {
Ted Kremenekb7770c02008-07-15 17:06:13 +0000102 $FoundAnalysis = 1;
103 }
Ted Kremenek991c54b2008-08-08 20:46:42 +0000104
Ted Kremenekb7770c02008-07-15 17:06:13 +0000105 next;
106 }
107
108 if (/^\s\s\s\s([^\s]+)\s(.+)$/) {
109 next if ($1 =~ /-dump/ or $1 =~ /-view/
110 or $1 =~ /-checker-simple/ or $1 =~ /-warn-uninit/);
111
112 $AvailableAnalyses{$1} = $2;
113 next;
114 }
115
116 last;
117}
118
119close (PIPE);
120
121my %AnalysesDefaultEnabled = (
122 '-warn-dead-stores' => 1,
123 '-checker-cfref' => 1,
Ted Kremenek90125992008-07-15 23:41:32 +0000124 '-warn-objc-methodsigs' => 1,
Ted Kremenekbde3a052008-07-25 20:35:01 +0000125 '-warn-objc-missing-dealloc' => 1,
Ted Kremenek5d443492008-09-18 06:34:16 +0000126 '-warn-objc-unused-ivars' => 1,
Ted Kremenekb7770c02008-07-15 17:06:13 +0000127);
128
129##----------------------------------------------------------------------------##
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000130# GetHTMLRunDir - Construct an HTML directory name for the current sub-run.
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000131##----------------------------------------------------------------------------##
132
Sam Bishopa0e22662008-04-02 03:35:43 +0000133sub GetHTMLRunDir {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000134
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000135 die "Not enough arguments." if (@_ == 0);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000136 my $Dir = shift @_;
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000137
138 my $TmpMode = 0;
139 if (!defined $Dir) {
140 $Dir = "/tmp";
141 $TmpMode = 1;
142 }
143
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000144 # Get current date and time.
145
146 my @CurrentTime = localtime();
147
148 my $year = $CurrentTime[5] + 1900;
149 my $day = $CurrentTime[3];
150 my $month = $CurrentTime[4] + 1;
151
Ted Kremenek9d7405f2008-05-14 17:23:56 +0000152 my $DateString = sprintf("%d-%02d-%02d", $year, $month, $day);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000153
154 # Determine the run number.
155
156 my $RunNumber;
157
158 if (-d $Dir) {
159
160 if (! -r $Dir) {
Ted Kremenek23cfca32008-06-16 22:40:14 +0000161 DieDiag("directory '$Dir' exists but is not readable.\n");
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000162 }
163
164 # Iterate over all files in the specified directory.
165
166 my $max = 0;
167
168 opendir(DIR, $Dir);
Ted Kremenek29da6c52008-08-07 17:57:34 +0000169 my @FILES = grep { -d "$Dir/$_" } readdir(DIR);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000170 closedir(DIR);
171
172 foreach my $f (@FILES) {
173
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000174 # Strip the prefix '$Prog-' if we are dumping files to /tmp.
175 if ($TmpMode) {
176 next if (!($f =~ /^$Prog-(.+)/));
177 $f = $1;
178 }
179
Ted Kremenekebb74132008-09-21 06:58:09 +0000180
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000181 my @x = split/-/, $f;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000182 next if (scalar(@x) != 4);
183 next if ($x[0] != $year);
184 next if ($x[1] != $month);
185 next if ($x[2] != $day);
186
187 if ($x[3] > $max) {
188 $max = $x[3];
189 }
190 }
191
192 $RunNumber = $max + 1;
193 }
194 else {
195
196 if (-x $Dir) {
Ted Kremenek23cfca32008-06-16 22:40:14 +0000197 DieDiag("'$Dir' exists but is not a directory.\n");
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000198 }
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000199
200 if ($TmpMode) {
Ted Kremenek445fa772008-10-10 00:17:08 +0000201 DieDiag("The directory '/tmp' does not exist or cannot be accessed.\n");
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000202 }
203
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000204 # $Dir does not exist. It will be automatically created by the
205 # clang driver. Set the run number to 1.
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000206
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000207 $RunNumber = 1;
208 }
209
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000210 die "RunNumber must be defined!" if (!defined $RunNumber);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000211
212 # Append the run number.
Ted Kremenekfc0898a2008-09-04 23:56:36 +0000213 my $NewDir;
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000214 if ($TmpMode) {
Ted Kremenekfc0898a2008-09-04 23:56:36 +0000215 $NewDir = "$Dir/$Prog-$DateString-$RunNumber";
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000216 }
217 else {
Ted Kremenekfc0898a2008-09-04 23:56:36 +0000218 $NewDir = "$Dir/$DateString-$RunNumber";
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000219 }
Ted Kremenekfc0898a2008-09-04 23:56:36 +0000220 system 'mkdir','-p',$NewDir;
221 return $NewDir;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000222}
223
Sam Bishopa0e22662008-04-02 03:35:43 +0000224sub SetHtmlEnv {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000225
226 die "Wrong number of arguments." if (scalar(@_) != 2);
227
228 my $Args = shift;
229 my $Dir = shift;
230
231 die "No build command." if (scalar(@$Args) == 0);
232
233 my $Cmd = $$Args[0];
234
235 if ($Cmd =~ /configure/) {
236 return;
237 }
238
239 if ($Verbose) {
Ted Kremenek23cfca32008-06-16 22:40:14 +0000240 Diag("Emitting reports for this run to '$Dir'.\n");
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000241 }
242
243 $ENV{'CCC_ANALYZER_HTML'} = $Dir;
244}
245
246##----------------------------------------------------------------------------##
Ted Kremenek57cf4462008-04-18 15:09:30 +0000247# ComputeDigest - Compute a digest of the specified file.
248##----------------------------------------------------------------------------##
249
250sub ComputeDigest {
251 my $FName = shift;
Ted Kremenek23cfca32008-06-16 22:40:14 +0000252 DieDiag("Cannot read $FName to compute Digest.\n") if (! -r $FName);
Ted Kremeneka6e24812008-04-19 18:05:48 +0000253
254 # Use Digest::MD5. We don't have to be cryptographically secure. We're
Ted Kremenek7ea02e62008-04-19 18:07:44 +0000255 # just looking for duplicate files that come from a non-malicious source.
256 # We use Digest::MD5 because it is a standard Perl module that should
Ted Kremenek63c20172008-08-04 17:34:06 +0000257 # come bundled on most systems.
Ted Kremenek23cfca32008-06-16 22:40:14 +0000258 open(FILE, $FName) or DieDiag("Cannot open $FName when computing Digest.\n");
Ted Kremeneka6e24812008-04-19 18:05:48 +0000259 binmode FILE;
260 my $Result = Digest::MD5->new->addfile(*FILE)->hexdigest;
261 close(FILE);
262
Ted Kremenek63c20172008-08-04 17:34:06 +0000263 # Return the digest.
Ted Kremeneka6e24812008-04-19 18:05:48 +0000264 return $Result;
Ted Kremenek57cf4462008-04-18 15:09:30 +0000265}
266
267##----------------------------------------------------------------------------##
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000268# UpdatePrefix - Compute the common prefix of files.
269##----------------------------------------------------------------------------##
270
271my $Prefix;
272
273sub UpdatePrefix {
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000274 my $x = shift;
275 my $y = basename($x);
276 $x =~ s/\Q$y\E$//;
277
278 # Ignore /usr, /Library, /System, /Developer
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000279 return if ( $x =~ /^\/usr/ or $x =~ /^\/Library/
280 or $x =~ /^\/System/ or $x =~ /^\/Developer/);
281
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000282 if (!defined $Prefix) {
283 $Prefix = $x;
284 return;
285 }
286
Ted Kremenek20b2bae2008-09-11 21:15:10 +0000287 chop $Prefix while (!($x =~ /^\Q$Prefix/));
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000288}
289
290sub GetPrefix {
291 return $Prefix;
292}
293
294##----------------------------------------------------------------------------##
295# UpdateInFilePath - Update the path in the report file.
296##----------------------------------------------------------------------------##
297
298sub UpdateInFilePath {
299 my $fname = shift;
300 my $regex = shift;
301 my $newtext = shift;
Ted Kremenek63c20172008-08-04 17:34:06 +0000302
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000303 open (RIN, $fname) or die "cannot open $fname";
Ted Kremenek63c20172008-08-04 17:34:06 +0000304 open (ROUT, ">", "$fname.tmp") or die "cannot open $fname.tmp";
305
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000306 while (<RIN>) {
307 s/$regex/$newtext/;
308 print ROUT $_;
309 }
Ted Kremenek63c20172008-08-04 17:34:06 +0000310
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000311 close (ROUT);
312 close (RIN);
Ted Kremenek20161e92008-07-15 20:18:21 +0000313 system("mv", "$fname.tmp", $fname);
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000314}
315
316##----------------------------------------------------------------------------##
Ted Kremenek5744dc22008-04-02 18:03:36 +0000317# ScanFile - Scan a report file for various identifying attributes.
318##----------------------------------------------------------------------------##
319
Ted Kremenek57cf4462008-04-18 15:09:30 +0000320# Sometimes a source file is scanned more than once, and thus produces
321# multiple error reports. We use a cache to solve this problem.
322
323my %AlreadyScanned;
324
Ted Kremenek5744dc22008-04-02 18:03:36 +0000325sub ScanFile {
326
327 my $Index = shift;
328 my $Dir = shift;
329 my $FName = shift;
330
Ted Kremenek57cf4462008-04-18 15:09:30 +0000331 # Compute a digest for the report file. Determine if we have already
332 # scanned a file that looks just like it.
333
334 my $digest = ComputeDigest("$Dir/$FName");
335
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000336 if (defined $AlreadyScanned{$digest}) {
Ted Kremenek57cf4462008-04-18 15:09:30 +0000337 # Redundant file. Remove it.
Ted Kremenek20161e92008-07-15 20:18:21 +0000338 system ("rm", "-f", "$Dir/$FName");
Ted Kremenek57cf4462008-04-18 15:09:30 +0000339 return;
340 }
341
342 $AlreadyScanned{$digest} = 1;
343
Ted Kremenek809709f2008-04-18 16:58:34 +0000344 # At this point the report file is not world readable. Make it happen.
Ted Kremenek20161e92008-07-15 20:18:21 +0000345 system ("chmod", "644", "$Dir/$FName");
Ted Kremenek684bb092008-04-18 15:18:20 +0000346
347 # Scan the report file for tags.
Ted Kremenek23cfca32008-06-16 22:40:14 +0000348 open(IN, "$Dir/$FName") or DieDiag("Cannot open '$Dir/$FName'\n");
Ted Kremenek5744dc22008-04-02 18:03:36 +0000349
350 my $BugDesc = "";
Ted Kremenek22d6a632008-04-02 20:43:36 +0000351 my $BugFile = "";
Ted Kremenekebb74132008-09-21 06:58:09 +0000352 my $BugCategory;
Ted Kremenek22d6a632008-04-02 20:43:36 +0000353 my $BugPathLength = 1;
354 my $BugLine = 0;
Ted Kremenekebb74132008-09-21 06:58:09 +0000355 my $found = 0;
356
Ted Kremenek5744dc22008-04-02 18:03:36 +0000357 while (<IN>) {
Ted Kremenekebb74132008-09-21 06:58:09 +0000358
359 last if ($found == 5);
360
Ted Kremenek5744dc22008-04-02 18:03:36 +0000361 if (/<!-- BUGDESC (.*) -->$/) {
362 $BugDesc = $1;
Ted Kremenekebb74132008-09-21 06:58:09 +0000363 ++$found;
Ted Kremenek5744dc22008-04-02 18:03:36 +0000364 }
Ted Kremenek22d6a632008-04-02 20:43:36 +0000365 elsif (/<!-- BUGFILE (.*) -->$/) {
366 $BugFile = $1;
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000367 UpdatePrefix($BugFile);
Ted Kremenekebb74132008-09-21 06:58:09 +0000368 ++$found;
Ted Kremenek22d6a632008-04-02 20:43:36 +0000369 }
370 elsif (/<!-- BUGPATHLENGTH (.*) -->$/) {
371 $BugPathLength = $1;
Ted Kremenekebb74132008-09-21 06:58:09 +0000372 ++$found;
Ted Kremenek22d6a632008-04-02 20:43:36 +0000373 }
374 elsif (/<!-- BUGLINE (.*) -->$/) {
375 $BugLine = $1;
Ted Kremenekebb74132008-09-21 06:58:09 +0000376 ++$found;
377 }
378 elsif (/<!-- BUGCATEGORY (.*) -->$/) {
379 $BugCategory = $1;
380 ++$found;
Ted Kremenek22d6a632008-04-02 20:43:36 +0000381 }
Ted Kremenek5744dc22008-04-02 18:03:36 +0000382 }
383
384 close(IN);
Ted Kremenekebb74132008-09-21 06:58:09 +0000385
386 if (!defined $BugCategory) {
387 $BugCategory = "Other";
388 }
Ted Kremenek5744dc22008-04-02 18:03:36 +0000389
Ted Kremenek81983112008-09-28 04:13:09 +0000390 push @$Index,[ $FName, $BugCategory, $BugDesc, $BugFile, $BugLine,
391 $BugPathLength ];
Ted Kremenek22d6a632008-04-02 20:43:36 +0000392}
393
394##----------------------------------------------------------------------------##
Ted Kremenek3ce12072008-09-22 17:50:47 +0000395# CopyFiles - Copy resource files to target directory.
Ted Kremenek22d6a632008-04-02 20:43:36 +0000396##----------------------------------------------------------------------------##
397
Ted Kremenek3ce12072008-09-22 17:50:47 +0000398sub CopyFiles {
Ted Kremenek22d6a632008-04-02 20:43:36 +0000399
400 my $Dir = shift;
Ted Kremeneke15fa272008-10-13 21:46:42 +0000401
402 my $JS = Cwd::realpath("$RealBin/sorttable.js");
Ted Kremenek22d6a632008-04-02 20:43:36 +0000403
Ted Kremenek23cfca32008-06-16 22:40:14 +0000404 DieDiag("Cannot find 'sorttable.js'.\n")
Ted Kremeneke15fa272008-10-13 21:46:42 +0000405 if (! -r $JS);
Ted Kremenek22d6a632008-04-02 20:43:36 +0000406
Ted Kremeneke15fa272008-10-13 21:46:42 +0000407 system ("cp", $JS, "$Dir");
Ted Kremenek22d6a632008-04-02 20:43:36 +0000408
Ted Kremenek23cfca32008-06-16 22:40:14 +0000409 DieDiag("Could not copy 'sorttable.js' to '$Dir'.\n")
Ted Kremenek22d6a632008-04-02 20:43:36 +0000410 if (! -r "$Dir/sorttable.js");
Ted Kremenek3ce12072008-09-22 17:50:47 +0000411
Ted Kremeneke15fa272008-10-13 21:46:42 +0000412 my $CSS = Cwd::realpath("$RealBin/scanview.css");
413
Ted Kremenek3ce12072008-09-22 17:50:47 +0000414 DieDiag("Cannot find 'scanview.css'.\n")
Ted Kremeneke15fa272008-10-13 21:46:42 +0000415 if (! -r $CSS);
Ted Kremenek3ce12072008-09-22 17:50:47 +0000416
Ted Kremeneke15fa272008-10-13 21:46:42 +0000417 system ("cp", $CSS, "$Dir");
Ted Kremenek3ce12072008-09-22 17:50:47 +0000418
419 DieDiag("Could not copy 'scanview.css' to '$Dir'.\n")
Ted Kremeneke15fa272008-10-13 21:46:42 +0000420 if (! -r $CSS);
Ted Kremenek5744dc22008-04-02 18:03:36 +0000421}
422
423##----------------------------------------------------------------------------##
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000424# Postprocess - Postprocess the results of an analysis scan.
425##----------------------------------------------------------------------------##
426
Sam Bishopa0e22662008-04-02 03:35:43 +0000427sub Postprocess {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000428
429 my $Dir = shift;
Ted Kremenek684bb092008-04-18 15:18:20 +0000430 my $BaseDir = shift;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000431
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000432 die "No directory specified." if (!defined $Dir);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000433
434 if (! -d $Dir) {
Ted Kremenek23cfca32008-06-16 22:40:14 +0000435 Diag("No bugs found.\n");
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000436 return 0;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000437 }
438
439 opendir(DIR, $Dir);
Ted Kremenek991c54b2008-08-08 20:46:42 +0000440 my $Crashes = 0;
441 my @files = grep { if ($_ eq "crashes") { $Crashes++; }
442 /^report-.*\.html$/; } readdir(DIR);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000443 closedir(DIR);
444
Ted Kremenek991c54b2008-08-08 20:46:42 +0000445 if (scalar(@files) == 0 and $Crashes == 0) {
Ted Kremenek23cfca32008-06-16 22:40:14 +0000446 Diag("Removing directory '$Dir' because it contains no reports.\n");
Ted Kremenek20161e92008-07-15 20:18:21 +0000447 system ("rm", "-fR", $Dir);
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000448 return 0;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000449 }
Ted Kremenek5744dc22008-04-02 18:03:36 +0000450
Ted Kremenek991c54b2008-08-08 20:46:42 +0000451 # Scan each report file and build an index.
452 my @Index;
Ted Kremenek5744dc22008-04-02 18:03:36 +0000453 foreach my $file (@files) { ScanFile(\@Index, $Dir, $file); }
454
Ted Kremenekd52e4252008-08-25 20:45:07 +0000455 # Scan the crashes directory and use the information in the .info files
456 # to update the common prefix directory.
457 if (-d "$Dir/crashes") {
458 opendir(DIR, "$Dir/crashes");
Ted Kremenek82a12532008-09-25 00:25:16 +0000459 my @files = grep { /[.]info.txt$/; } readdir(DIR);
Ted Kremenekd52e4252008-08-25 20:45:07 +0000460 closedir(DIR);
461 foreach my $file (@files) {
462 open IN, "$Dir/crashes/$file" or DieDiag("cannot open $file\n");
463 my $Path = <IN>;
464 if (defined $Path) { UpdatePrefix($Path); }
465 close IN;
466 }
467 }
468
Ted Kremenek63c20172008-08-04 17:34:06 +0000469 # Generate an index.html file.
470 my $FName = "$Dir/index.html";
471 open(OUT, ">", $FName) or DieDiag("Cannot create file '$FName'\n");
Ted Kremenek5744dc22008-04-02 18:03:36 +0000472
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000473 # Print out the header.
474
Ted Kremenek5744dc22008-04-02 18:03:36 +0000475print OUT <<ENDTEXT;
476<html>
477<head>
Ted Kremenek7cba1122008-09-22 01:35:58 +0000478<title>${HtmlTitle}</title>
Ted Kremenekf1435452008-09-23 22:34:51 +0000479<link type="text/css" rel="stylesheet" href="scanview.css"/>
Ted Kremenek22d6a632008-04-02 20:43:36 +0000480<script src="sorttable.js"></script>
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000481<script language='javascript' type="text/javascript">
482function SetDisplay(RowClass, DisplayVal)
483{
484 var Rows = document.getElementsByTagName("tr");
485 for ( var i = 0 ; i < Rows.length; ++i ) {
486 if (Rows[i].className == RowClass) {
487 Rows[i].style.display = DisplayVal;
488 }
489 }
490}
Ted Kremenekebb74132008-09-21 06:58:09 +0000491
Ted Kremenek2350a462008-10-28 19:56:52 +0000492function CopyCheckedStateToCheckButtons(SummaryCheckButton) {
493 var Inputs = document.getElementsByTagName("input");
494 for ( var i = 0 ; i < Inputs.length; ++i ) {
495 if (Inputs[i].type == "checkbox") {
496 if(Inputs[i] != SummaryCheckButton) {
497 Inputs[i].checked = SummaryCheckButton.checked;
498 Inputs[i].onclick();
499 }
500 }
501 }
502}
503
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000504function ToggleDisplay(CheckButton, ClassName) {
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000505 if (CheckButton.checked) {
506 SetDisplay(ClassName, "");
507 }
508 else {
509 SetDisplay(ClassName, "none");
510 }
511}
512</script>
Ted Kremenek1d1abb12008-09-22 17:52:58 +0000513<!-- SUMMARYENDHEAD -->
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000514</head>
515<body>
Ted Kremenek7cba1122008-09-22 01:35:58 +0000516<h1>${HtmlTitle}</h1>
517
518<table>
519<tr><th>User:</th><td>${UserName}\@${HostName}</td></tr>
520<tr><th>Working Directory:</th><td>${CurrentDir}</td></tr>
521<tr><th>Command Line:</th><td>${CmdArgs}</td></tr>
522<tr><th>Date:</th><td>${Date}</td></tr>
523ENDTEXT
524
525print OUT "<tr><th>Version:</th><td>${BuildName} (${BuildDate})</td></tr>\n"
526 if (defined($BuildName) && defined($BuildDate));
527
528print OUT <<ENDTEXT;
529</table>
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000530ENDTEXT
531
Ted Kremenek991c54b2008-08-08 20:46:42 +0000532 if (scalar(@files)) {
533 # Print out the summary table.
534 my %Totals;
Ted Kremenekebb74132008-09-21 06:58:09 +0000535
Ted Kremenek991c54b2008-08-08 20:46:42 +0000536 for my $row ( @Index ) {
Ted Kremenekebb74132008-09-21 06:58:09 +0000537 my $bug_type = ($row->[2]);
538 my $bug_category = ($row->[1]);
539 my $key = "$bug_category:$bug_type";
540
541 if (!defined $Totals{$key}) { $Totals{$key} = [1,$bug_category,$bug_type]; }
542 else { $Totals{$key}->[0]++; }
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000543 }
Ted Kremenek991c54b2008-08-08 20:46:42 +0000544
Ted Kremenek7cba1122008-09-22 01:35:58 +0000545 print OUT "<h2>Bug Summary</h2>";
Ted Kremenek991c54b2008-08-08 20:46:42 +0000546
547 if (defined $BuildName) {
548 print OUT "\n<p>Results in this analysis run are based on analyzer build <b>$BuildName</b>.</p>\n"
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000549 }
Ted Kremenekf4cdf412008-05-23 18:17:05 +0000550
Ted Kremenek2350a462008-10-28 19:56:52 +0000551
552 my $TotalBugs = scalar(@Index);
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000553print OUT <<ENDTEXT;
Ted Kremenekebb74132008-09-21 06:58:09 +0000554<table>
555<thead><tr><td>Bug Type</td><td>Quantity</td><td class="sorttable_nosort">Display?</td></tr></thead>
Ted Kremenek2350a462008-10-28 19:56:52 +0000556<tr style="font-weight:bold"><td class="SUMM_DESC">All Bugs</td><td class="Q">$TotalBugs</td><td><center><input type="checkbox" onClick="CopyCheckedStateToCheckButtons(this);" checked/></center></td></tr>
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000557ENDTEXT
558
Ted Kremenekebb74132008-09-21 06:58:09 +0000559 my $last_category;
560
561 for my $key (
562 sort {
563 my $x = $Totals{$a};
564 my $y = $Totals{$b};
565 my $res = $x->[1] cmp $y->[1];
566 $res = $x->[2] cmp $y->[2] if ($res == 0);
567 $res
568 } keys %Totals )
569 {
570 my $val = $Totals{$key};
571 my $category = $val->[1];
572 if (!defined $last_category or $last_category ne $category) {
573 $last_category = $category;
574 print OUT "<tr><th>$category</th><th colspan=2></th></tr>\n";
575 }
576 my $x = lc $key;
577 $x =~ s/[ ,'":\/()]+/_/g;
578 print OUT "<tr><td class=\"SUMM_DESC\">";
579 print OUT $val->[2];
Ted Kremenek2350a462008-10-28 19:56:52 +0000580 print OUT "</td><td class=\"Q\">";
Ted Kremenekebb74132008-09-21 06:58:09 +0000581 print OUT $val->[0];
582 print OUT "</td><td><center><input type=\"checkbox\" onClick=\"ToggleDisplay(this,'bt_$x');\" checked/></center></td></tr>\n";
Ted Kremenek991c54b2008-08-08 20:46:42 +0000583 }
Ted Kremenek6e6eff72008-04-15 20:47:02 +0000584
585 # Print out the table of errors.
586
587print OUT <<ENDTEXT;
588</table>
Ted Kremenek7cba1122008-09-22 01:35:58 +0000589<h2>Reports</h2>
Ted Kremenekebb74132008-09-21 06:58:09 +0000590
591<table class="sortable" style="table-layout:automatic">
592<thead><tr>
593 <td>Bug Group</td>
594 <td class="sorttable_sorted">Bug Type<span id="sorttable_sortfwdind">&nbsp;&#x25BE;</span></td>
Ted Kremenekbba1cf52008-04-03 05:50:51 +0000595 <td>File</td>
Ted Kremenekebb74132008-09-21 06:58:09 +0000596 <td class="Q">Line</td>
Ted Kremenek81983112008-09-28 04:13:09 +0000597 <td class="Q">Path Length</td>
Ted Kremenek2645c772008-07-07 16:58:44 +0000598 <td class="sorttable_nosort"></td>
Ted Kremenekebb74132008-09-21 06:58:09 +0000599 <!-- REPORTBUGCOL -->
600</tr></thead>
601<tbody>
Ted Kremenek5744dc22008-04-02 18:03:36 +0000602ENDTEXT
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000603
Ted Kremenek991c54b2008-08-08 20:46:42 +0000604 my $prefix = GetPrefix();
605 my $regex;
606 my $InFileRegex;
607 my $InFilePrefix = "File:</td><td>";
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000608
Ted Kremenek991c54b2008-08-08 20:46:42 +0000609 if (defined $prefix) {
610 $regex = qr/^\Q$prefix\E/is;
611 $InFileRegex = qr/\Q$InFilePrefix$prefix\E/is;
612 }
Ted Kremenek7a4648d2008-05-02 22:04:53 +0000613
Ted Kremenekebb74132008-09-21 06:58:09 +0000614 for my $row ( sort { $a->[2] cmp $b->[2] } @Index ) {
615 my $x = "$row->[1]:$row->[2]";
616 $x = lc $x;
617 $x =~ s/[ ,'":\/()]+/_/g;
Ted Kremenek5744dc22008-04-02 18:03:36 +0000618
Ted Kremenek991c54b2008-08-08 20:46:42 +0000619 my $ReportFile = $row->[0];
Ted Kremenekebb74132008-09-21 06:58:09 +0000620
621 print OUT "<tr class=\"bt_$x\">";
622 print OUT "<td class=\"DESC\">";
Ted Kremenek991c54b2008-08-08 20:46:42 +0000623 print OUT $row->[1];
Ted Kremenekebb74132008-09-21 06:58:09 +0000624 print OUT "</td>";
625 print OUT "<td class=\"DESC\">";
626 print OUT $row->[2];
627 print OUT "</td>";
628
629 # Update the file prefix.
630 my $fname = $row->[3];
Ted Kremenekebb74132008-09-21 06:58:09 +0000631
Ted Kremenek991c54b2008-08-08 20:46:42 +0000632 if (defined $regex) {
633 $fname =~ s/$regex//;
634 UpdateInFilePath("$Dir/$ReportFile", $InFileRegex, $InFilePrefix)
635 }
Ted Kremenekebb74132008-09-21 06:58:09 +0000636
Ted Kremenek91639ef2008-09-22 17:42:31 +0000637 print OUT "<td>";
Ted Kremenekebb74132008-09-21 06:58:09 +0000638 my @fname = split /\//,$fname;
639 if ($#fname > 0) {
640 while ($#fname >= 0) {
641 my $x = shift @fname;
642 print OUT $x;
643 if ($#fname >= 0) {
644 print OUT "<span class=\"W\"> </span>/";
645 }
646 }
647 }
648 else {
649 print OUT $fname;
Ted Kremenek91639ef2008-09-22 17:42:31 +0000650 }
Ted Kremenekebb74132008-09-21 06:58:09 +0000651 print OUT "</td>";
652
653 # Print out the quantities.
Ted Kremenek81983112008-09-28 04:13:09 +0000654 for my $j ( 4 .. 5 ) {
Ted Kremenekebb74132008-09-21 06:58:09 +0000655 print OUT "<td class=\"Q\">$row->[$j]</td>";
656 }
657
Ted Kremenek991c54b2008-08-08 20:46:42 +0000658 # Print the rest of the columns.
Ted Kremenek81983112008-09-28 04:13:09 +0000659 for (my $j = 6; $j <= $#{$row}; ++$j) {
Ted Kremenekebb74132008-09-21 06:58:09 +0000660 print OUT "<td>$row->[$j]</td>"
Ted Kremenek991c54b2008-08-08 20:46:42 +0000661 }
Ted Kremenek7f8a3252008-04-02 18:42:49 +0000662
Ted Kremenek991c54b2008-08-08 20:46:42 +0000663 # Emit the "View" link.
Ted Kremenek68005dd2008-09-22 17:39:18 +0000664 print OUT "<td><a href=\"$ReportFile#EndPath\">View Report</a></td>";
Ted Kremenek3cea9ee2008-07-30 17:58:08 +0000665
Daniel Dunbare43038e2008-09-19 23:18:44 +0000666 # Emit REPORTBUG markers.
Ted Kremenekebb74132008-09-21 06:58:09 +0000667 print OUT "\n<!-- REPORTBUG id=\"$ReportFile\" -->\n";
Daniel Dunbare43038e2008-09-19 23:18:44 +0000668
Ted Kremenek991c54b2008-08-08 20:46:42 +0000669 # End the row.
670 print OUT "</tr>\n";
671 }
672
Ted Kremenekebb74132008-09-21 06:58:09 +0000673 print OUT "</tbody>\n</table>\n\n";
Ted Kremenek991c54b2008-08-08 20:46:42 +0000674 }
675
676 if ($Crashes) {
677 # Read the crash directory for files.
678 opendir(DIR, "$Dir/crashes");
Ted Kremenek82a12532008-09-25 00:25:16 +0000679 my @files = grep { /[.]info.txt$/ } readdir(DIR);
Ted Kremenek991c54b2008-08-08 20:46:42 +0000680 closedir(DIR);
681
682 if (scalar(@files)) {
683 print OUT <<ENDTEXT;
Ted Kremenek7cba1122008-09-22 01:35:58 +0000684<h2>Analyzer Failures</h2>
Ted Kremenek991c54b2008-08-08 20:46:42 +0000685
Ted Kremenek5d31f832008-08-18 18:38:29 +0000686<p>The analyzer had problems processing the following files:</p>
Ted Kremenek991c54b2008-08-08 20:46:42 +0000687
688<table>
Ted Kremenek9f9b1fd2008-09-12 22:49:36 +0000689<thead><tr><td>Problem</td><td>Source File</td><td>Preprocessed File</td><td>STDERR Output</td></tr></thead>
Ted Kremenek991c54b2008-08-08 20:46:42 +0000690ENDTEXT
691
692 foreach my $file (sort @files) {
Ted Kremenek82a12532008-09-25 00:25:16 +0000693 $file =~ /(.+).info.txt$/;
Ted Kremenek991c54b2008-08-08 20:46:42 +0000694 # Get the preprocessed file.
695 my $ppfile = $1;
696 # Open the info file and get the name of the source file.
697 open (INFO, "$Dir/crashes/$file") or
698 die "Cannot open $Dir/crashes/$file\n";
699 my $srcfile = <INFO>;
Ted Kremenek5d31f832008-08-18 18:38:29 +0000700 chomp $srcfile;
701 my $problem = <INFO>;
702 chomp $problem;
Ted Kremenek991c54b2008-08-08 20:46:42 +0000703 close (INFO);
704 # Print the information in the table.
Ted Kremenekd52e4252008-08-25 20:45:07 +0000705 my $prefix = GetPrefix();
Ted Kremenek9f9b1fd2008-09-12 22:49:36 +0000706 if (defined $prefix) { $srcfile =~ s/^\Q$prefix//; }
707 print OUT "<tr><td>$problem</td><td>$srcfile</td><td><a href=\"crashes/$ppfile\">$ppfile</a></td><td><a href=\"crashes/$ppfile.stderr.txt\">$ppfile.stderr.txt</a></td></tr>\n";
Daniel Dunbarce723ce2008-09-25 01:10:50 +0000708 my $ppfile_clang = $ppfile;
709 $ppfile_clang =~ s/[.](.+)$/.clang.$1/;
Daniel Dunbar7ebe0ed2008-09-25 06:05:31 +0000710 print OUT " <!-- REPORTPROBLEM src=\"$srcfile\" file=\"crashes/$ppfile\" clangfile=\"crashes/$ppfile_clang\" stderr=\"crashes/$ppfile.stderr.txt\" info=\"crashes/$ppfile.info.txt\" -->\n";
Ted Kremenek991c54b2008-08-08 20:46:42 +0000711 }
712
713 print OUT <<ENDTEXT;
714</table>
Daniel Dunbarce723ce2008-09-25 01:10:50 +0000715<p>Please consider submitting preprocessed files as <a href="http://clang.llvm.org/StaticAnalysisUsage.html#filingbugs">bug reports</a>. <!-- REPORTCRASHES --> </p>
Ted Kremenek991c54b2008-08-08 20:46:42 +0000716ENDTEXT
717 }
Ted Kremenek5744dc22008-04-02 18:03:36 +0000718 }
719
Ted Kremenek991c54b2008-08-08 20:46:42 +0000720 print OUT "</body></html>\n";
Ted Kremenek5744dc22008-04-02 18:03:36 +0000721 close(OUT);
Ted Kremenek3ce12072008-09-22 17:50:47 +0000722 CopyFiles($Dir);
Ted Kremenek20161e92008-07-15 20:18:21 +0000723
724 # Make sure $Dir and $BaseDir are world readable/executable.
725 system("chmod", "755", $Dir);
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000726 if (defined $BaseDir) { system("chmod", "755", $BaseDir); }
Ted Kremenek20161e92008-07-15 20:18:21 +0000727
Ted Kremenek23cfca32008-06-16 22:40:14 +0000728 my $Num = scalar(@Index);
Ted Kremenek150c2122008-07-11 19:15:05 +0000729 Diag("$Num bugs found.\n");
730 if ($Num > 0 && -r "$Dir/index.html") {
Ted Kremenek5950b3f2008-09-22 06:47:01 +0000731 Diag("Run 'scan-view $Dir' to examine bug reports.\n");
Ted Kremenek150c2122008-07-11 19:15:05 +0000732 }
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000733
Ted Kremenek991c54b2008-08-08 20:46:42 +0000734 DiagCrashes($Dir) if ($Crashes);
735
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000736 return $Num;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000737}
738
739##----------------------------------------------------------------------------##
Ted Kremenekdab11102008-04-02 04:43:42 +0000740# RunBuildCommand - Run the build command.
741##----------------------------------------------------------------------------##
742
Ted Kremenek6b628982008-04-30 23:47:12 +0000743sub AddIfNotPresent {
744 my $Args = shift;
745 my $Arg = shift;
746 my $found = 0;
747
748 foreach my $k (@$Args) {
749 if ($k eq $Arg) {
750 $found = 1;
751 last;
752 }
753 }
754
755 if ($found == 0) {
756 push @$Args, $Arg;
757 }
758}
759
Ted Kremenekdab11102008-04-02 04:43:42 +0000760sub RunBuildCommand {
761
762 my $Args = shift;
Ted Kremenek7442ca62008-04-02 16:04:51 +0000763 my $IgnoreErrors = shift;
Ted Kremenekdab11102008-04-02 04:43:42 +0000764 my $Cmd = $Args->[0];
Ted Kremenek6195c372008-06-02 21:52:47 +0000765 my $CCAnalyzer = shift;
Ted Kremenekdab11102008-04-02 04:43:42 +0000766
Ted Kremenek3301cb12008-06-30 18:18:16 +0000767 # Get only the part of the command after the last '/'.
768 if ($Cmd =~ /\/([^\/]+)$/) {
769 $Cmd = $1;
770 }
771
Ted Kremenek63c20172008-08-04 17:34:06 +0000772 if ($Cmd eq "gcc" or $Cmd eq "cc" or $Cmd eq "llvm-gcc"
773 or $Cmd eq "ccc-analyzer") {
Ted Kremenekdab11102008-04-02 04:43:42 +0000774 shift @$Args;
Ted Kremenek6195c372008-06-02 21:52:47 +0000775 unshift @$Args, $CCAnalyzer;
Ted Kremenekdab11102008-04-02 04:43:42 +0000776 }
Ted Kremenek7442ca62008-04-02 16:04:51 +0000777 elsif ($IgnoreErrors) {
778 if ($Cmd eq "make" or $Cmd eq "gmake") {
Ted Kremenek6b628982008-04-30 23:47:12 +0000779 AddIfNotPresent($Args,"-k");
Ted Kremenek8912b542008-05-13 21:28:02 +0000780 AddIfNotPresent($Args,"-i");
Ted Kremenek7442ca62008-04-02 16:04:51 +0000781 }
782 elsif ($Cmd eq "xcodebuild") {
Ted Kremenek6b628982008-04-30 23:47:12 +0000783 AddIfNotPresent($Args,"-PBXBuildsContinueAfterErrors=YES");
Ted Kremenek7442ca62008-04-02 16:04:51 +0000784 }
Ted Kremenek6b628982008-04-30 23:47:12 +0000785 }
786
Ted Kremenek6b628982008-04-30 23:47:12 +0000787 if ($Cmd eq "xcodebuild") {
Ted Kremenekcfd4c7b2008-05-23 22:18:16 +0000788 # Disable distributed builds for xcodebuild.
Ted Kremenek6b628982008-04-30 23:47:12 +0000789 AddIfNotPresent($Args,"-nodistribute");
Ted Kremenekcfd4c7b2008-05-23 22:18:16 +0000790
791 # Disable PCH files until clang supports them.
792 AddIfNotPresent($Args,"GCC_PRECOMPILE_PREFIX_HEADER=NO");
Ted Kremenek915e9722008-05-27 23:18:07 +0000793
794 # When 'CC' is set, xcodebuild uses it to do all linking, even if we are
795 # linking C++ object files. Set 'LDPLUSPLUS' so that xcodebuild uses 'g++'
796 # when linking such files.
Ted Kremenek95aa1052008-09-04 17:52:41 +0000797 die if (!defined $CXX);
798 my $LDPLUSPLUS = `which $CXX`;
Ted Kremenek915e9722008-05-27 23:18:07 +0000799 $LDPLUSPLUS =~ s/\015?\012//; # strip newlines
800 $ENV{'LDPLUSPLUS'} = $LDPLUSPLUS;
Ted Kremenek6b628982008-04-30 23:47:12 +0000801 }
Ted Kremenekdab11102008-04-02 04:43:42 +0000802
Ted Kremenek5a4ddaf2008-08-25 20:10:45 +0000803 return (system(@$Args) >> 8);
Ted Kremenekdab11102008-04-02 04:43:42 +0000804}
805
Ted Kremenekdab11102008-04-02 04:43:42 +0000806##----------------------------------------------------------------------------##
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000807# DisplayHelp - Utility function to display all help options.
808##----------------------------------------------------------------------------##
809
Sam Bishopa0e22662008-04-02 03:35:43 +0000810sub DisplayHelp {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000811
Ted Kremenek5744dc22008-04-02 18:03:36 +0000812print <<ENDTEXT;
Sam Bishopa0e22662008-04-02 03:35:43 +0000813USAGE: $Prog [options] <build command> [build options]
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000814
Ted Kremenekf4cdf412008-05-23 18:17:05 +0000815ENDTEXT
816
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000817 if (defined $BuildName) {
Ted Kremenekf4cdf412008-05-23 18:17:05 +0000818 print "ANALYZER BUILD: $BuildName ($BuildDate)\n\n";
819 }
820
821print <<ENDTEXT;
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000822OPTIONS:
823
Ted Kremeneke15fa272008-10-13 21:46:42 +0000824 -analyze-headers - Also analyze functions in #included files.
825
Zhongxing Xu07c37672008-10-27 14:26:32 +0000826 -store [model] - Specify the store model used by the analyzer. By default,
827 the 'basic' store model is used. 'region' specifies a field-
828 sensitive store model. Be warned that the 'region' model
829 is still in very early testing phase and may often crash.
830
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000831 -o - Target directory for HTML report files. Subdirectories
Sam Bishopa0e22662008-04-02 03:35:43 +0000832 will be created as needed to represent separate "runs" of
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000833 the analyzer. If this option is not specified, a directory
834 is created in /tmp to store the reports.
Ted Kremenek1262fc42008-05-14 20:10:33 +0000835
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000836 -h - Display this message.
837 --help
Ted Kremenek1262fc42008-05-14 20:10:33 +0000838
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000839 -k - Add a "keep on going" option to the specified build command.
840 --keep-going This option currently supports make and xcodebuild.
Ted Kremenekf02e8db2008-04-02 16:41:25 +0000841 This is a convenience option; one can specify this
842 behavior directly using build options.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000843
Ted Kremenek7cba1122008-09-22 01:35:58 +0000844 --html-title [title] - Specify the title used on generated HTML pages.
845 --html-title=[title] If not specified, a default title will be used.
846
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000847 --status-bugs - By default, the exit status of $Prog is the same as the
848 executed build command. Specifying this option causes the
849 exit status of $Prog to be 1 if it found potential bugs
850 and 0 otherwise.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000851
Ted Kremenek386c6932008-09-03 17:59:35 +0000852 --use-cc [compiler path] - By default, $Prog uses 'gcc' to compile and link
853 --use-cc=[compiler path] your C and Objective-C code. Use this option
854 to specify an alternate compiler.
855
856 --use-c++ [compiler path] - By default, $Prog uses 'g++' to compile and link
857 --use-c++=[compiler path] your C++ and Objective-C++ code. Use this option
858 to specify an alternate compiler.
Ted Kremenekf17ef3c2008-08-21 21:47:09 +0000859
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000860 -v - Verbose output from $Prog and the analyzer.
Ted Kremenek386c6932008-09-03 17:59:35 +0000861 A second and third '-v' increases verbosity.
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000862
863 -V - View analysis results in a web browser when the build
864 --view completes.
Ted Kremenek7f8a3252008-04-02 18:42:49 +0000865
Ted Kremenekb7770c02008-07-15 17:06:13 +0000866
Ted Kremenek386c6932008-09-03 17:59:35 +0000867AVAILABLE ANALYSES (multiple analyses may be specified):
Ted Kremenekd52e4252008-08-25 20:45:07 +0000868
869ENDTEXT
Ted Kremenekb7770c02008-07-15 17:06:13 +0000870
871 foreach my $Analysis (sort keys %AvailableAnalyses) {
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000872 if (defined $AnalysesDefaultEnabled{$Analysis}) {
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000873 print " (+)";
Ted Kremenekb7770c02008-07-15 17:06:13 +0000874 }
875 else {
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000876 print " ";
Ted Kremenekb7770c02008-07-15 17:06:13 +0000877 }
878
879 print " $Analysis $AvailableAnalyses{$Analysis}\n";
880 }
881
882print <<ENDTEXT
883
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000884 NOTE: "(+)" indicates that an analysis is enabled by default unless one
885 or more analysis options are specified
Ted Kremenekb7770c02008-07-15 17:06:13 +0000886
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000887BUILD OPTIONS
888
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000889 You can specify any build option acceptable to the build command.
Ted Kremenek39eefde2008-04-02 16:47:27 +0000890
Ted Kremenek5744dc22008-04-02 18:03:36 +0000891EXAMPLE
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000892
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000893 $Prog -o /tmp/myhtmldir make -j4
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000894
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000895 The above example causes analysis reports to be deposited into
896 a subdirectory of "/tmp/myhtmldir" and to run "make" with the "-j4" option.
897 A different subdirectory is created each time $Prog analyzes a project.
898 The analyzer should support most parallel builds, but not distributed builds.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000899
900ENDTEXT
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000901}
902
903##----------------------------------------------------------------------------##
Ted Kremenek7cba1122008-09-22 01:35:58 +0000904# HtmlEscape - HTML entity encode characters that are special in HTML
905##----------------------------------------------------------------------------##
906
907sub HtmlEscape {
908 # copy argument to new variable so we don't clobber the original
909 my $arg = shift || '';
910 my $tmp = $arg;
911
912 $tmp =~ s/([\<\>\'\"])/sprintf("&#%02x;", chr($1))/ge;
913
914 return $tmp;
915}
916
917##----------------------------------------------------------------------------##
918# ShellEscape - backslash escape characters that are special to the shell
919##----------------------------------------------------------------------------##
920
921sub ShellEscape {
922 # copy argument to new variable so we don't clobber the original
923 my $arg = shift || '';
924 my $tmp = $arg;
925
926 $tmp =~ s/([\!\;\\\'\"\`\<\>\|\s\(\)\[\]\?\#\$\^\&\*\=])/\\$1/g;
927
928 return $tmp;
929}
930
931##----------------------------------------------------------------------------##
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000932# Process command-line arguments.
933##----------------------------------------------------------------------------##
934
Ted Kremeneke15fa272008-10-13 21:46:42 +0000935my $AnalyzeHeaders = 0;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000936my $HtmlDir; # Parent directory to store HTML files.
937my $IgnoreErrors = 0; # Ignore build errors.
Ted Kremenek7f8a3252008-04-02 18:42:49 +0000938my $ViewResults = 0; # View results when the build terminates.
Ted Kremenek363dc3f2008-07-15 22:03:09 +0000939my $ExitStatusFoundBugs = 0; # Exit status reflects whether bugs were found
Ted Kremenekb7770c02008-07-15 17:06:13 +0000940my @AnalysesToRun;
Zhongxing Xu07c37672008-10-27 14:26:32 +0000941my $StoreModel;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000942
943if (!@ARGV) {
944 DisplayHelp();
Sam Bishopa0e22662008-04-02 03:35:43 +0000945 exit 1;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000946}
947
948while (@ARGV) {
949
950 # Scan for options we recognize.
951
952 my $arg = $ARGV[0];
953
Sam Bishop2f2418e2008-04-03 14:29:47 +0000954 if ($arg eq "-h" or $arg eq "--help") {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000955 DisplayHelp();
Sam Bishopa0e22662008-04-02 03:35:43 +0000956 exit 0;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000957 }
958
Ted Kremeneke15fa272008-10-13 21:46:42 +0000959 if ($arg eq '-analyze-headers') {
960 shift @ARGV;
961 $AnalyzeHeaders = 1;
962 next;
963 }
964
Ted Kremenekfc1d3402008-08-04 18:15:26 +0000965 if (defined $AvailableAnalyses{$arg}) {
Ted Kremenek1262fc42008-05-14 20:10:33 +0000966 shift @ARGV;
Ted Kremenekb7770c02008-07-15 17:06:13 +0000967 push @AnalysesToRun, $arg;
Ted Kremenek1262fc42008-05-14 20:10:33 +0000968 next;
969 }
970
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000971 if ($arg eq "-o") {
972 shift @ARGV;
973
974 if (!@ARGV) {
Ted Kremenek23cfca32008-06-16 22:40:14 +0000975 DieDiag("'-o' option requires a target directory name.\n");
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000976 }
977
978 $HtmlDir = shift @ARGV;
979 next;
980 }
Ted Kremenek7cba1122008-09-22 01:35:58 +0000981
982 if ($arg =~ /^--html-title(=(.+))?$/) {
983 shift @ARGV;
984
985 if ($2 eq '') {
986 if (!@ARGV) {
987 DieDiag("'--html-title' option requires a string.\n");
988 }
989
990 $HtmlTitle = shift @ARGV;
991 } else {
992 $HtmlTitle = $2;
993 }
994
995 next;
996 }
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000997
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000998 if ($arg eq "-k" or $arg eq "--keep-going") {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000999 shift @ARGV;
1000 $IgnoreErrors = 1;
1001 next;
1002 }
1003
Ted Kremenekf17ef3c2008-08-21 21:47:09 +00001004 if ($arg =~ /^--use-cc(=(.+))?$/) {
1005 shift @ARGV;
1006 my $cc;
1007
1008 if ($2 eq "") {
1009 if (!@ARGV) {
1010 DieDiag("'--use-cc' option requires a compiler executable name.\n");
1011 }
1012 $cc = shift @ARGV;
1013 }
1014 else {
1015 $cc = $2;
1016 }
1017
1018 $ENV{"CCC_CC"} = $cc;
1019 next;
1020 }
1021
Ted Kremenek7cba1122008-09-22 01:35:58 +00001022 if ($arg =~ /^--use-c\+\+(=(.+))?$/) {
Ted Kremenek386c6932008-09-03 17:59:35 +00001023 shift @ARGV;
1024
1025 if ($2 eq "") {
1026 if (!@ARGV) {
1027 DieDiag("'--use-c++' option requires a compiler executable name.\n");
1028 }
1029 $CXX = shift @ARGV;
1030 }
1031 else {
1032 $CXX = $2;
1033 }
1034 next;
1035 }
1036
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001037 if ($arg eq "-v") {
1038 shift @ARGV;
1039 $Verbose++;
1040 next;
1041 }
1042
Ted Kremenek7f8a3252008-04-02 18:42:49 +00001043 if ($arg eq "-V" or $arg eq "--view") {
1044 shift @ARGV;
1045 $ViewResults = 1;
1046 next;
1047 }
1048
Ted Kremenek363dc3f2008-07-15 22:03:09 +00001049 if ($arg eq "--status-bugs") {
1050 shift @ARGV;
1051 $ExitStatusFoundBugs = 1;
1052 next;
1053 }
Zhongxing Xu07c37672008-10-27 14:26:32 +00001054
1055 if ($arg eq "-store") {
1056 shift @ARGV;
1057 $StoreModel = '-analyzer-store-' . shift @ARGV;
1058 next;
1059 }
Ted Kremenek363dc3f2008-07-15 22:03:09 +00001060
Ted Kremenek23cfca32008-06-16 22:40:14 +00001061 DieDiag("unrecognized option '$arg'\n") if ($arg =~ /^-/);
Ted Kremenek0062ad42008-04-02 16:35:01 +00001062
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001063 last;
1064}
1065
1066if (!@ARGV) {
Ted Kremenek23cfca32008-06-16 22:40:14 +00001067 Diag("No build command specified.\n\n");
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001068 DisplayHelp();
Sam Bishopa0e22662008-04-02 03:35:43 +00001069 exit 1;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001070}
1071
Ted Kremenek7cba1122008-09-22 01:35:58 +00001072$CmdArgs = HtmlEscape(join(' ', map(ShellEscape($_), @ARGV)));
1073$HtmlTitle = "${CurrentDirSuffix} - scan-build results"
1074 unless (defined($HtmlTitle));
Ted Kremenek386c6932008-09-03 17:59:35 +00001075
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001076# Determine the output directory for the HTML reports.
Ted Kremenek684bb092008-04-18 15:18:20 +00001077my $BaseDir = $HtmlDir;
Sam Bishopa0e22662008-04-02 03:35:43 +00001078$HtmlDir = GetHTMLRunDir($HtmlDir);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001079
1080# Set the appropriate environment variables.
Sam Bishopa0e22662008-04-02 03:35:43 +00001081SetHtmlEnv(\@ARGV, $HtmlDir);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001082
Ted Kremeneke15fa272008-10-13 21:46:42 +00001083my $Cmd = Cwd::realpath("$RealBin/ccc-analyzer");
Ted Kremenek0b6c1532008-04-08 20:22:12 +00001084
Ted Kremenek23cfca32008-06-16 22:40:14 +00001085DieDiag("Executable 'ccc-analyzer' does not exist at '$Cmd'\n")
Ted Kremenek0b6c1532008-04-08 20:22:12 +00001086 if (! -x $Cmd);
Ted Kremenekf22eacb2008-04-18 22:00:56 +00001087
Ted Kremenekb7770c02008-07-15 17:06:13 +00001088if (! -x $ClangSB) {
1089 Diag("'clang' executable not found in '$RealBin'.\n");
1090 Diag("Using 'clang' from path.\n");
Ted Kremenekf22eacb2008-04-18 22:00:56 +00001091}
Ted Kremenek0b6c1532008-04-08 20:22:12 +00001092
Ted Kremenek95aa1052008-09-04 17:52:41 +00001093if (defined $CXX) {
1094 $ENV{'CXX'} = $CXX;
1095}
1096else {
1097 $CXX = 'g++'; # This variable is used by other parts of scan-build
1098 # that need to know a default C++ compiler to fall back to.
1099}
1100
Ted Kremenek4f4b17d2008-04-03 20:08:18 +00001101$ENV{'CC'} = $Cmd;
Ted Kremenekf22eacb2008-04-18 22:00:56 +00001102$ENV{'CLANG'} = $Clang;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001103
1104if ($Verbose >= 2) {
1105 $ENV{'CCC_ANALYZER_VERBOSE'} = 1;
1106}
1107
Ted Kremeneka9525c92008-05-12 22:07:14 +00001108if ($Verbose >= 3) {
1109 $ENV{'CCC_ANALYZER_LOG'} = 1;
1110}
1111
Ted Kremenek90125992008-07-15 23:41:32 +00001112if (scalar(@AnalysesToRun) == 0) {
1113 foreach my $key (keys %AnalysesDefaultEnabled) {
1114 push @AnalysesToRun,$key;
1115 }
Ted Kremenek01006782008-07-02 23:16:10 +00001116}
Ted Kremenek1262fc42008-05-14 20:10:33 +00001117
Ted Kremeneke15fa272008-10-13 21:46:42 +00001118if ($AnalyzeHeaders) {
1119 push @AnalysesToRun,"-analyzer-opt-analyze-headers";
1120}
1121
Ted Kremenek90125992008-07-15 23:41:32 +00001122$ENV{'CCC_ANALYZER_ANALYSIS'} = join ' ',@AnalysesToRun;
1123
Zhongxing Xu07c37672008-10-27 14:26:32 +00001124if ($StoreModel) {
1125 $ENV{'CCC_ANALYZER_STORE_MODEL'} = $StoreModel;
1126}
1127
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001128# Run the build.
Ted Kremenek5656a982008-07-15 17:09:28 +00001129my $ExitStatus = RunBuildCommand(\@ARGV, $IgnoreErrors, $Cmd);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +00001130
1131# Postprocess the HTML directory.
Ted Kremenek363dc3f2008-07-15 22:03:09 +00001132my $NumBugs = Postprocess($HtmlDir, $BaseDir);
Ted Kremenek7f8a3252008-04-02 18:42:49 +00001133
1134if ($ViewResults and -r "$HtmlDir/index.html") {
Ted Kremenek50534dc2008-09-22 17:38:23 +00001135 Diag "Analysis run complete.\n";
Ted Kremenek5950b3f2008-09-22 06:47:01 +00001136 Diag "Viewing analysis results in '$HtmlDir' using scan-view.\n";
Ted Kremeneke15fa272008-10-13 21:46:42 +00001137 my $ScanView = Cwd::realpath("$RealBin/scan-view");
Ted Kremenek5950b3f2008-09-22 06:47:01 +00001138 if (! -x $ScanView) { $ScanView = "scan-view"; }
1139 exec $ScanView, "$HtmlDir";
Ted Kremenek7f8a3252008-04-02 18:42:49 +00001140}
Ted Kremenek5656a982008-07-15 17:09:28 +00001141
Ted Kremenek363dc3f2008-07-15 22:03:09 +00001142if ($ExitStatusFoundBugs) {
1143 exit 1 if ($NumBugs > 0);
1144 exit 0;
1145}
1146
Ted Kremenek5656a982008-07-15 17:09:28 +00001147exit $ExitStatus;
1148