Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / clang / 3110251f13981689f384eb3c0aba2afffea18d9d / . / utils / scan-build
blob: 1f8aefbd88d1a943dae291327ba3fa66825788ba [file] [log] [blame]
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]1#!/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;
17use File::Temp qw/ :mktemp /;
18
19my $Verbose = 0; # Verbose output from this script.
20my $Prog = "scan-build";
21
22##----------------------------------------------------------------------------##
23# GetHTMLRunDir - Construct an HTML directory name for the current run.
24##----------------------------------------------------------------------------##
25
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]26sub GetHTMLRunDir {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]27
28 die "Not enough arguments." if (@_ == 0);
29
30 my $Dir = shift @_;
31
32 # Get current date and time.
33
34 my @CurrentTime = localtime();
35
36 my $year = $CurrentTime[5] + 1900;
37 my $day = $CurrentTime[3];
38 my $month = $CurrentTime[4] + 1;
39
40 my $DateString = "$year-$month-$day";
41
42 # Determine the run number.
43
44 my $RunNumber;
45
46 if (-d $Dir) {
47
48 if (! -r $Dir) {
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]49 die "error: '$Dir' exists but is not readable.\n";
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]50 }
51
52 # Iterate over all files in the specified directory.
53
54 my $max = 0;
55
56 opendir(DIR, $Dir);
57 my @FILES= readdir(DIR);
58 closedir(DIR);
59
60 foreach my $f (@FILES) {
61
62 my @x = split/-/, $f;
63
64 next if (scalar(@x) != 4);
65 next if ($x[0] != $year);
66 next if ($x[1] != $month);
67 next if ($x[2] != $day);
68
69 if ($x[3] > $max) {
70 $max = $x[3];
71 }
72 }
73
74 $RunNumber = $max + 1;
75 }
76 else {
77
78 if (-x $Dir) {
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]79 die "error: '$Dir' exists but is not a directory.\n";
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]80 }
81
82 # $Dir does not exist. It will be automatically created by the
83 # clang driver. Set the run number to 1.
84
85 $RunNumber = 1;
86 }
87
88 die "RunNumber must be defined!" if (!defined($RunNumber));
89
90 # Append the run number.
91
92 return "$Dir/$DateString-$RunNumber";
93}
94
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]95sub SetHtmlEnv {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]96
97 die "Wrong number of arguments." if (scalar(@_) != 2);
98
99 my $Args = shift;
100 my $Dir = shift;
101
102 die "No build command." if (scalar(@$Args) == 0);
103
104 my $Cmd = $$Args[0];
105
106 if ($Cmd =~ /configure/) {
107 return;
108 }
109
110 if ($Verbose) {
111 print "$Prog: Emitting reports for this run to '$Dir'.\n";
112 }
113
114 $ENV{'CCC_ANALYZER_HTML'} = $Dir;
115}
116
117##----------------------------------------------------------------------------##
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]118# ScanFile - Scan a report file for various identifying attributes.
119##----------------------------------------------------------------------------##
120
121sub ScanFile {
122
123 my $Index = shift;
124 my $Dir = shift;
125 my $FName = shift;
126
127 open(IN, "$Dir/$FName") or die "$Prog: Cannot open '$Dir/$FName'\n";
128
129 my $BugDesc = "";
130
131 while (<IN>) {
132
133 if (/<!-- BUGDESC (.*) -->$/) {
134 $BugDesc = $1;
135 last;
136 }
137
138 }
139
140 close(IN);
141
142 push @$Index,[ $FName, $BugDesc ];
143}
144
145##----------------------------------------------------------------------------##
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]146# Postprocess - Postprocess the results of an analysis scan.
147##----------------------------------------------------------------------------##
148
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]149sub Postprocess {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]150
151 my $Dir = shift;
152
153 die "No directory specified." if (!defined($Dir));
154
155 if (! -d $Dir) {
156 return;
157 }
158
159 opendir(DIR, $Dir);
160 my @files = grep(/^report-.*\.html$/,readdir(DIR));
161 closedir(DIR);
162
163 if (scalar(@files) == 0) {
Ted Kremenek02493782008-04-02 07:05:07 +0000[diff] [blame]164 print "$Prog: Removing directory '$Dir' because it contains no reports.\n";
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]165 `rm -fR $Dir`;
166 return;
167 }
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]168
169 # Scan each report file and build an index.
170
171 my @Index;
172
173 foreach my $file (@files) { ScanFile(\@Index, $Dir, $file); }
174
175 # Generate an index.html file.
176
177 my $FName = "$Dir/index.html";
178
179 open(OUT, ">$FName") or die "$Prog: Cannot create file '$FName'\n";
180
181print OUT <<ENDTEXT;
182<html>
183<head>
184</head>\n<body>
185<table class="reports">
186ENDTEXT
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]187
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]188 for my $row ( sort { $a->[1] cmp $b->[1] } @Index ) {
189
190 print OUT "<tr>\n";
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]191
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]192 my $ReportFile = $row->[0];
193
194 print OUT " <td class=\"DESC\">$row->[1]</td>\n";
195
196 for my $j ( 2 .. $#{$row} ) {
197 print OUT "<td>$row->[$j]</td>\n"
198 }
199
200# print OUT "<td><input type=\"button\" value=\"View\"></td>\n";
201 print OUT "<td><a href=\"$ReportFile#EndPath\">View</a></td>\n";
202 print OUT "</tr>\n";
203 }
204
205 print OUT "</table>\n</body></html>\n";
206 close(OUT);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]207}
208
209##----------------------------------------------------------------------------##
Ted Kremenekdab11102008-04-02 04:43:42 +0000[diff] [blame]210# RunBuildCommand - Run the build command.
211##----------------------------------------------------------------------------##
212
213sub RunBuildCommand {
214
215 my $Args = shift;
Ted Kremenek7442ca62008-04-02 16:04:51 +0000[diff] [blame]216 my $IgnoreErrors = shift;
Ted Kremenekdab11102008-04-02 04:43:42 +0000[diff] [blame]217 my $Cmd = $Args->[0];
218
Ted Kremenek6a43ba92008-04-02 15:34:12 +0000[diff] [blame]219 if ($Cmd eq "gcc" or $Cmd eq "cc" or $Cmd eq "llvm-gcc") {
Ted Kremenekdab11102008-04-02 04:43:42 +0000[diff] [blame]220 shift @$Args;
221 unshift @$Args, "ccc-analyzer"
222 }
Ted Kremenek7442ca62008-04-02 16:04:51 +0000[diff] [blame]223 elsif ($IgnoreErrors) {
224 if ($Cmd eq "make" or $Cmd eq "gmake") {
225 push @$Args, "-k";
226 }
227 elsif ($Cmd eq "xcodebuild") {
228 push @$Args, "-PBXBuildsContinueAfterErrors=YES";
229 }
230 }
Ted Kremenekdab11102008-04-02 04:43:42 +0000[diff] [blame]231
232 system(@$Args);
233}
234
Ted Kremenekdab11102008-04-02 04:43:42 +0000[diff] [blame]235##----------------------------------------------------------------------------##
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]236# DisplayHelp - Utility function to display all help options.
237##----------------------------------------------------------------------------##
238
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]239sub DisplayHelp {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]240
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]241print <<ENDTEXT;
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]242USAGE: $Prog [options] <build command> [build options]
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]243
244OPTIONS:
245
246 -o - Target directory for HTML report files. Subdirectories
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]247 will be created as needed to represent separate "runs" of
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]248 the analyzer. If this option is not specified, a directory
249 is created in /tmp to store the reports.
250
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]251 -?, -h - Display this message.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]252 --help
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]253
Ted Kremenekaf08f642008-04-02 16:31:58 +0000[diff] [blame]254 -k - Add a "keep on going" option to the specified build command.
Ted Kremenekf02e8db2008-04-02 16:41:25 +0000[diff] [blame]255 --keep-going This option currently supports make and xcodebuild.
256 This is a convenience option; one can specify this
257 behavior directly using build options.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]258
Ted Kremenekdab11102008-04-02 04:43:42 +0000[diff] [blame]259 -v - Verbose output from $Prog and the analyzer.
260 A second "-v" increases verbosity.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]261
262BUILD OPTIONS
263
Ted Kremenek39eefde2008-04-02 16:47:27 +0000[diff] [blame]264 You can specify any build option acceptable to the build command.
265
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]266EXAMPLE
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]267
Ted Kremenek5744dc22008-04-02 18:03:36 +0000[diff] [blame]268 $Prog -o /tmp/myhtmldir make -j4
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]269
Ted Kremenek39eefde2008-04-02 16:47:27 +0000[diff] [blame]270 The above example causes analysis reports to be deposited into
271 a subdirectory of "/tmp/myhtmldir" and to run "make" with the "-j4" option.
272 A different subdirectory is created each time $Prog analyzes a project.
273 The analyzer should support most parallel builds, but not distributed builds.
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]274
275ENDTEXT
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]276}
277
278##----------------------------------------------------------------------------##
279# Process command-line arguments.
280##----------------------------------------------------------------------------##
281
282my $HtmlDir; # Parent directory to store HTML files.
283my $IgnoreErrors = 0; # Ignore build errors.
284
285if (!@ARGV) {
286 DisplayHelp();
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]287 exit 1;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]288}
289
290while (@ARGV) {
291
292 # Scan for options we recognize.
293
294 my $arg = $ARGV[0];
295
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]296 if ($arg eq "-?" or $arg eq "-h" or $arg eq "--help") {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]297 DisplayHelp();
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]298 exit 0;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]299 }
300
301 if ($arg eq "-o") {
302 shift @ARGV;
303
304 if (!@ARGV) {
Ted Kremenek0062ad42008-04-02 16:35:01 +0000[diff] [blame]305 die "$Prog: '-o' option requires a target directory name.\n";
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]306 }
307
308 $HtmlDir = shift @ARGV;
309 next;
310 }
311
Ted Kremenek2b74ab62008-04-01 21:22:03 +0000[diff] [blame]312 if ($arg eq "-k" or $arg eq "--keep-going") {
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]313 shift @ARGV;
314 $IgnoreErrors = 1;
315 next;
316 }
317
318 if ($arg eq "-v") {
319 shift @ARGV;
320 $Verbose++;
321 next;
322 }
323
Ted Kremenek0062ad42008-04-02 16:35:01 +0000[diff] [blame]324 die "$Prog: unrecognized option '$arg'\n" if ($arg =~ /^-/);
325
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]326 last;
327}
328
329if (!@ARGV) {
330 print STDERR "$Prog: No build command specified.\n\n";
331 DisplayHelp();
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]332 exit 1;
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]333}
334
335# Determine the output directory for the HTML reports.
336
337if (!defined($HtmlDir)) {
338
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]339 $HtmlDir = mkdtemp("/tmp/$Prog-XXXXXX");
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]340
341 if (!defined($HtmlDir)) {
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]342 die "error: Cannot create HTML directory in /tmp.\n";
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]343 }
344
345 if (!$Verbose) {
346 print "$Prog: Using '$HtmlDir' as base HTML report directory.\n";
347 }
348}
349
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]350$HtmlDir = GetHTMLRunDir($HtmlDir);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]351
352# Set the appropriate environment variables.
353
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]354SetHtmlEnv(\@ARGV, $HtmlDir);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]355
356$ENV{'CC'} = "ccc-analyzer";
357
358if ($Verbose >= 2) {
359 $ENV{'CCC_ANALYZER_VERBOSE'} = 1;
360}
361
362# Run the build.
363
Ted Kremenek7442ca62008-04-02 16:04:51 +0000[diff] [blame]364RunBuildCommand(\@ARGV, $IgnoreErrors);
Ted Kremenek9cc8c2c2008-04-01 20:47:38 +0000[diff] [blame]365
366# Postprocess the HTML directory.
367
Sam Bishopa0e22662008-04-02 03:35:43 +0000[diff] [blame]368Postprocess($HtmlDir);