blob: 9f07009f15c9a6205769aad4f365c8ba05461621 [file] [log] [blame]
Ted Kremenekfbeeca82008-07-19 06:11:04 +00001#!/usr/bin/env perl
Ted Kremenekb0982882008-03-25 22:35:32 +00002#
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#
Ted Kremenekfbeeca82008-07-19 06:11:04 +000010# A script designed to interpose between the build system and gcc. It invokes
11# both gcc and the static analyzer.
Ted Kremenekb0982882008-03-25 22:35:32 +000012#
13##===----------------------------------------------------------------------===##
14
Ted Kremenekfbeeca82008-07-19 06:11:04 +000015use strict;
16use warnings;
Ted Kremenekb315a392008-09-21 19:56:14 +000017use Cwd qw/ getcwd abs_path /;
Ted Kremenek991c54b2008-08-08 20:46:42 +000018use File::Temp qw/ tempfile /;
19use File::Path qw / mkpath /;
Ted Kremenek2ec5cd52008-08-25 20:44:31 +000020
21my $CC = $ENV{'CCC_CC'};
22if (!defined $CC) { $CC = "gcc"; }
Ted Kremenek991c54b2008-08-08 20:46:42 +000023
24##----------------------------------------------------------------------------##
25# Process Clang Crashes.
26##----------------------------------------------------------------------------##
27
28sub GetPPExt {
29 my $Lang = shift;
30 if ($Lang =~ /objective-c/) { return ".mi"; }
31 return ".i";
32}
33
Ted Kremenek5d31f832008-08-18 18:38:29 +000034sub ProcessClangFailure {
Ted Kremenekc3998fa2008-09-25 00:51:44 +000035 my ($Clang, $Lang, $file, $Args, $HtmlDir, $ErrorType, $ofile) = @_;
Ted Kremenek991c54b2008-08-08 20:46:42 +000036 my $Dir = "$HtmlDir/crashes";
37 mkpath $Dir;
Ted Kremenekc3998fa2008-09-25 00:51:44 +000038
39 # Generate the preprocessed file with cc (i.e., gcc).
Ted Kremenek991c54b2008-08-08 20:46:42 +000040 my ($PPH, $PPFile) = tempfile("clang_crash_XXXXXX",
41 SUFFIX => GetPPExt($Lang),
42 DIR => $Dir);
43
Ted Kremenek2ec5cd52008-08-25 20:44:31 +000044 system $CC, @$Args, "-E", "-o", $PPFile;
Ted Kremenek991c54b2008-08-08 20:46:42 +000045 close ($PPH);
Ted Kremenekc3998fa2008-09-25 00:51:44 +000046
47 # Generate the preprocessed file with clang.
48 my $PPFile_Clang = $PPFile;
49 $PPFile_Clang =~ s/[.](.+)$/.clang.$1/;
50 system $Clang, @$Args, "-E", "-o", "$PPFile_Clang";
51
52 # Create the info file.
Ted Kremenek82a12532008-09-25 00:25:16 +000053 open (OUT, ">", "$PPFile.info.txt") or die "Cannot open $PPFile.info.txt\n";
Ted Kremenek5f2825f2008-09-21 18:04:49 +000054 print OUT abs_path($file), "\n";
Ted Kremenek5d31f832008-08-18 18:38:29 +000055 print OUT "$ErrorType\n";
Ted Kremenek2dd7ad12008-08-18 20:55:25 +000056 print OUT "@$Args\n";
Ted Kremenek991c54b2008-08-08 20:46:42 +000057 close OUT;
Ted Kremenek82a12532008-09-25 00:25:16 +000058 `uname -a >> $PPFile.info.txt 2>&1`;
59 `$CC -v >> $PPFile.info.txt 2>&1`;
Ted Kremenek9f9b1fd2008-09-12 22:49:36 +000060 system 'mv',$ofile,"$PPFile.stderr.txt";
Ted Kremenek991c54b2008-08-08 20:46:42 +000061}
Ted Kremenekb0982882008-03-25 22:35:32 +000062
Ted Kremenekfbeeca82008-07-19 06:11:04 +000063##----------------------------------------------------------------------------##
64# Running the analyzer.
65##----------------------------------------------------------------------------##
Ted Kremenekb0982882008-03-25 22:35:32 +000066
Ted Kremenekfbeeca82008-07-19 06:11:04 +000067sub Analyze {
68 my ($Clang, $Args, $Lang, $Output, $Verbose, $HtmlDir, $file, $Analyses) = @_;
Seo Sanghyeond3894652008-04-04 11:02:21 +000069
Ted Kremenekfbeeca82008-07-19 06:11:04 +000070 # Skip anything related to C++.
71 return if ($Lang =~ /c[+][+]/);
Ted Kremenek5d31f832008-08-18 18:38:29 +000072
Ted Kremenekfbeeca82008-07-19 06:11:04 +000073 my $RunAnalyzer = 0;
74 my $Cmd;
75 my @CmdArgs;
Ted Kremenek991c54b2008-08-08 20:46:42 +000076 my @CmdArgsSansAnalyses;
Ted Kremenek61cd9882008-05-24 15:58:54 +000077
Ted Kremenekfbeeca82008-07-19 06:11:04 +000078 if ($Lang =~ /header/) {
79 exit 0 if (!defined ($Output));
80 $Cmd = 'cp';
81 push @CmdArgs,$file;
82 # Remove the PCH extension.
83 $Output =~ s/[.]gch$//;
84 push @CmdArgs,$Output;
Ted Kremenek991c54b2008-08-08 20:46:42 +000085 @CmdArgsSansAnalyses = @CmdArgs;
Ted Kremenekfbeeca82008-07-19 06:11:04 +000086 }
87 else {
88 $Cmd = $Clang;
Ted Kremenekfbeeca82008-07-19 06:11:04 +000089 push @CmdArgs,'-DIBOutlet=__attribute__((iboutlet))';
90 push @CmdArgs,@$Args;
Ted Kremenek991c54b2008-08-08 20:46:42 +000091 @CmdArgsSansAnalyses = @CmdArgs;
92 push @CmdArgs,(split /\s/,$Analyses);
Ted Kremenekfbeeca82008-07-19 06:11:04 +000093 $RunAnalyzer = 1;
94 }
95
96 my @PrintArgs;
97 my $dir;
98
99 if ($Verbose) {
100 $dir = getcwd();
101 print STDERR "\n[LOCATION]: $dir\n";
102 push @PrintArgs,"'$Cmd'";
103 foreach my $arg (@CmdArgs) { push @PrintArgs,"\'$arg\'"; }
104 }
105
106 if ($Verbose == 1) {
Ted Kremenek61cd9882008-05-24 15:58:54 +0000107 # We MUST print to stderr. Some clients use the stdout output of
108 # gcc for various purposes.
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000109 print STDERR join(' ',@PrintArgs);
110 print STDERR "\n";
111 }
112 elsif ($Verbose == 2) {
113 print STDERR "#SHELL (cd '$dir' && @PrintArgs)\n";
114 }
Ted Kremenek61cd9882008-05-24 15:58:54 +0000115
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000116 if ($RunAnalyzer and defined($HtmlDir)) {
117 push @CmdArgs,'-o';
118 push @CmdArgs,$HtmlDir;
119 }
Ted Kremenek948e06b2008-08-27 22:30:34 +0000120
121 if (defined $ENV{'CCC_UBI'}) {
122 push @CmdArgs,"--analyzer-viz-egraph-ubigraph";
123 }
Ted Kremenek991c54b2008-08-08 20:46:42 +0000124
Ted Kremenek9a3c7da2008-09-04 00:02:34 +0000125 # Capture the STDERR of clang and send it to a temporary file.
126 # Capture the STDOUT of clang and reroute it to ccc-analyzer's STDERR.
127 # We save the output file in the 'crashes' directory if clang encounters
128 # any problems with the file.
Ted Kremenek13462682008-09-11 23:05:26 +0000129 pipe (FROM_CHILD, TO_PARENT);
Ted Kremenek9a3c7da2008-09-04 00:02:34 +0000130 my $pid = fork();
131 if ($pid == 0) {
Ted Kremenek13462682008-09-11 23:05:26 +0000132 close FROM_CHILD;
133 open(STDOUT,">&", \*TO_PARENT);
134 open(STDERR,">&", \*TO_PARENT);
Ted Kremenek9a3c7da2008-09-04 00:02:34 +0000135 exec $Cmd, @CmdArgs;
136 }
Ted Kremenek13462682008-09-11 23:05:26 +0000137
138 close TO_PARENT;
139 my ($ofh, $ofile) = tempfile("clang_output_XXXXXX", DIR => $HtmlDir);
140
141 while (<FROM_CHILD>) {
142 print $ofh $_;
143 print STDERR $_;
144 }
145
146 waitpid($pid,0);
Ted Kremenek9a3c7da2008-09-04 00:02:34 +0000147 my $Result = $?;
148
149 # Did the command die because of a signal?
150 if ($Result & 127 and $Cmd eq $Clang and defined $HtmlDir) {
Ted Kremenekc3998fa2008-09-25 00:51:44 +0000151 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, $HtmlDir,
Ted Kremenek9a3c7da2008-09-04 00:02:34 +0000152 "Crash", $ofile);
153 }
154 elsif ($Result) {
Ted Kremenekc3998fa2008-09-25 00:51:44 +0000155 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, $HtmlDir,
Ted Kremenek9a3c7da2008-09-04 00:02:34 +0000156 "Parser Rejects", $ofile);
157 }
158
159 `rm -f $ofile`;
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000160}
Ted Kremenek61cd9882008-05-24 15:58:54 +0000161
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000162##----------------------------------------------------------------------------##
163# Lookup tables.
164##----------------------------------------------------------------------------##
165
166my %CompileOptionMap = (
167 '-nostdinc' => 0,
168 '-fobjc-gc-only' => 0,
169 '-fobjc-gc' => 0,
170 '-include' => 1,
171 '-idirafter' => 1,
172 '-iprefix' => 1,
173 '-iquote' => 1,
174 '-isystem' => 1,
175 '-iwithprefix' => 1,
176 '-iwithprefixbefore' => 1
177);
178
179my %LinkerOptionMap = (
180 '-framework' => 1
181);
182
183my %CompilerLinkerOptionMap = (
184 '-isysroot' => 1,
185 '-arch' => 1,
Ted Kremeneke4f69522008-09-29 22:45:28 +0000186 '-v' => 0,
Ted Kremenekb10362a2008-09-30 23:40:25 +0000187 '-fpascal-strings' => 0,
188 '-mmacosx-version-min' => 0 # This is really a 1 argument, but always has '='
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000189);
190
191my %IgnoredOptionMap = (
Ted Kremenek94026092008-07-24 03:52:21 +0000192 '-MT' => 1, # Ignore these preprocessor options.
193 '-MF' => 1,
194
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000195 '-fsyntax-only' => 0,
196 '-save-temps' => 0,
197 '-install_name' => 1,
198 '-exported_symbols_list' => 1,
199 '-current_version' => 1,
200 '-compatibility_version' => 1,
201 '-init' => 1,
202 '-e' => 1,
203 '-seg1addr' => 1,
204 '-bundle_loader' => 1,
205 '-multiply_defined' => 1,
206 '-sectorder' => 3,
207 '--param' => 1,
208 '-u' => 1
209);
210
211my %LangMap = (
212 'c' => 'c',
213 'cpp' => 'c++',
214 'cc' => 'c++',
215 'i' => 'c-cpp-output',
216 'm' => 'objective-c',
217 'mi' => 'objective-c-cpp-output'
218);
219
Ted Kremeneka30730e2008-09-29 16:15:20 +0000220my %UniqueOptions = (
221 '-isysroot' => 0
222);
223
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000224##----------------------------------------------------------------------------##
225# Main Logic.
226##----------------------------------------------------------------------------##
227
228my $Action = 'link';
229my @CompileOpts;
230my @LinkOpts;
231my @Files;
232my $Lang;
233my $Output;
Ted Kremeneka30730e2008-09-29 16:15:20 +0000234my %Uniqued;
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000235
236# Forward arguments to gcc.
Ted Kremenekf17ef3c2008-08-21 21:47:09 +0000237my $Status = system($CC,@ARGV);
Ted Kremenekcb344d02008-08-28 01:18:44 +0000238if ($Status) { exit($Status >> 8); }
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000239
240# Get the analysis options.
241my $Analyses = $ENV{'CCC_ANALYZER_ANALYSIS'};
242if (!defined($Analyses)) { $Analyses = '-checker-cfref'; }
243
Zhongxing Xu07c37672008-10-27 14:26:32 +0000244# Get the store model.
245my $StoreModel = $ENV{'CCC_ANALYZER_STORE_MODEL'};
246
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000247# Determine the level of verbosity.
248my $Verbose = 0;
249if (defined $ENV{CCC_ANALYZER_VERBOSE}) { $Verbose = 1; }
250if (defined $ENV{CCC_ANALYZER_LOG}) { $Verbose = 2; }
251
252# Determine what clang executable to use.
253my $Clang = $ENV{'CLANG'};
254if (!defined $Clang) { $Clang = 'clang'; }
255
256# Get the HTML output directory.
257my $HtmlDir = $ENV{'CCC_ANALYZER_HTML'};
258
Ted Kremenek27783eb2008-09-25 20:17:57 +0000259my %ArchsSeen;
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000260
261# Process the arguments.
262foreach (my $i = 0; $i < scalar(@ARGV); ++$i) {
Ted Kremenek89c4fcf2008-10-19 06:42:38 +0000263 my $Arg = $ARGV[$i];
264 my ($ArgKey) = split /=/,$Arg,2;
265
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000266 # Modes ccc-analyzer supports
267 if ($Arg eq '-E') { $Action = 'preprocess'; }
268 elsif ($Arg eq '-c') { $Action = 'compile'; }
269 elsif ($Arg =~ /^-print-prog-name/) { exit 0; }
Ted Kremenek27783eb2008-09-25 20:17:57 +0000270
271 # Specially handle duplicate cases of -arch
272 if ($Arg eq "-arch") {
273 my $arch = $ARGV[$i+1];
274 $ArchsSeen{$arch} = 1;
275 ++$i;
276 next;
277 }
278
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000279 # Options with possible arguments that should pass through to compiler.
Ted Kremenek89c4fcf2008-10-19 06:42:38 +0000280 if (defined $CompileOptionMap{$ArgKey}) {
281 my $Cnt = $CompileOptionMap{$ArgKey};
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000282 push @CompileOpts,$Arg;
283 while ($Cnt > 0) { ++$i; --$Cnt; push @CompileOpts, $ARGV[$i]; }
284 next;
285 }
286
287 # Options with possible arguments that should pass through to linker.
Ted Kremenek89c4fcf2008-10-19 06:42:38 +0000288 if (defined $LinkerOptionMap{$ArgKey}) {
289 my $Cnt = $LinkerOptionMap{$ArgKey};
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000290 push @LinkOpts,$Arg;
291 while ($Cnt > 0) { ++$i; --$Cnt; push @LinkOpts, $ARGV[$i]; }
292 next;
293 }
294
295 # Options with possible arguments that should pass through to both compiler
296 # and the linker.
Ted Kremenek89c4fcf2008-10-19 06:42:38 +0000297 if (defined $CompilerLinkerOptionMap{$ArgKey}) {
298 my $Cnt = $CompilerLinkerOptionMap{$ArgKey};
Ted Kremenek47fc25f2008-09-29 23:06:09 +0000299
Ted Kremeneka30730e2008-09-29 16:15:20 +0000300 # Check if this is an option that should have a unique value, and if so
301 # determine if the value was checked before.
302 if ($UniqueOptions{$Arg}) {
303 if (defined $Uniqued{$Arg}) {
304 $i += $Cnt;
305 next;
306 }
307 $Uniqued{$Arg} = 1;
308 }
309
Ted Kremenek47fc25f2008-09-29 23:06:09 +0000310 push @CompileOpts,$Arg;
311 push @LinkOpts,$Arg;
312
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000313 while ($Cnt > 0) {
314 ++$i; --$Cnt;
315 push @CompileOpts, $ARGV[$i];
316 push @LinkOpts, $ARGV[$i];
317 }
318 next;
319 }
Ted Kremenek61cd9882008-05-24 15:58:54 +0000320
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000321 # Ignored options.
Ted Kremenek89c4fcf2008-10-19 06:42:38 +0000322 if (defined $IgnoredOptionMap{$ArgKey}) {
323 my $Cnt = $IgnoredOptionMap{$ArgKey};
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000324 while ($Cnt > 0) {
325 ++$i; --$Cnt;
326 }
327 next;
328 }
Ted Kremenek61cd9882008-05-24 15:58:54 +0000329
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000330 # Compile mode flags.
331 if ($Arg =~ /^-[D,I,U](.*)$/) {
332 my $Tmp = $Arg;
333 if ($1 eq '') {
334 # FIXME: Check if we are going off the end.
335 ++$i;
336 $Tmp = $Arg . $ARGV[$i];
337 }
338 push @CompileOpts,$Tmp;
339 next;
340 }
341
342 # Language.
343 if ($Arg eq '-x') {
344 $Lang = $ARGV[$i+1];
345 ++$i; next;
346 }
Ted Kremenek61cd9882008-05-24 15:58:54 +0000347
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000348 # Output file.
349 if ($Arg eq '-o') {
350 ++$i;
351 $Output = $ARGV[$i];
352 next;
353 }
354
355 # Get the link mode.
356 if ($Arg =~ /^-[l,L,O]/) {
357 if ($Arg eq '-O') { push @LinkOpts,'-O1'; }
358 elsif ($Arg eq '-Os') { push @LinkOpts,'-O2'; }
359 else { push @LinkOpts,$Arg; }
360 next;
361 }
362
363 if ($Arg =~ /^-std=/) {
364 push @CompileOpts,$Arg;
365 next;
366 }
367
368# if ($Arg =~ /^-f/) {
369# # FIXME: Not sure if the remaining -fxxxx options have no arguments.
370# push @CompileOpts,$Arg;
371# push @LinkOpts,$Arg; # FIXME: Not sure if these are link opts.
372# }
373
374 # Get the compiler/link mode.
375 if ($Arg =~ /^-F(.+)$/) {
376 my $Tmp = $Arg;
377 if ($1 eq '') {
378 # FIXME: Check if we are going off the end.
379 ++$i;
380 $Tmp = $Arg . $ARGV[$i];
381 }
382 push @CompileOpts,$Tmp;
383 push @LinkOpts,$Tmp;
384 next;
385 }
Ted Kremenek61cd9882008-05-24 15:58:54 +0000386
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000387 # Input files.
388 if ($Arg eq '-filelist') {
389 # FIXME: Make sure we aren't walking off the end.
390 open(IN, $ARGV[$i+1]);
391 while (<IN>) { s/\015?\012//; push @Files,$_; }
392 close(IN);
393 ++$i; next;
394 }
395
396 if (!($Arg =~ /^-/)) {
397 push @Files,$Arg; next;
398 }
399}
Ted Kremenek61cd9882008-05-24 15:58:54 +0000400
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000401if ($Action eq 'compile' or $Action eq 'link') {
402 foreach my $file (@Files) {
403 # Determine the language for the file.
404 my $FileLang = $Lang;
405
406 if (!defined($FileLang)) {
407 # Infer the language from the extension.
408 if ($file =~ /[.]([^.]+)$/) {
409 $FileLang = $LangMap{$1};
410 }
411 }
Ted Kremenek1262fc42008-05-14 20:10:33 +0000412
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000413 next if (!defined $FileLang);
414
415 my @AnalyzeArgs;
416
417 if ($FileLang ne 'unknown') {
418 push @AnalyzeArgs,'-x';
419 push @AnalyzeArgs,$FileLang;
420 }
Ted Kremenekb0982882008-03-25 22:35:32 +0000421
Zhongxing Xu07c37672008-10-27 14:26:32 +0000422 if (defined $StoreModel) {
423 push @AnalyzeArgs, $StoreModel;
424 }
425
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000426 push @AnalyzeArgs,@CompileOpts;
427 push @AnalyzeArgs,$file;
Zhongxing Xu07c37672008-10-27 14:26:32 +0000428
Ted Kremenek27783eb2008-09-25 20:17:57 +0000429 my @Archs = keys %ArchsSeen;
430 if (scalar @Archs) {
431 foreach my $arch (@Archs) {
432 my @NewArgs;
433 push @NewArgs, '-arch';
434 push @NewArgs, $arch;
435 push @NewArgs, @AnalyzeArgs;
436 Analyze($Clang, \@NewArgs, $FileLang, $Output,
437 $Verbose, $HtmlDir, $file, $Analyses);
438 }
439 }
440 else {
441 Analyze($Clang, \@AnalyzeArgs, $FileLang, $Output,
442 $Verbose, $HtmlDir, $file, $Analyses);
443 }
Ted Kremenekfbeeca82008-07-19 06:11:04 +0000444 }
445}
Ted Kremenekb0982882008-03-25 22:35:32 +0000446
Ted Kremenek948e06b2008-08-27 22:30:34 +0000447exit($Status >> 8);
448