3 # The LLVM Compiler Infrastructure
5 # This file is distributed under the University of Illinois Open Source
6 # License. See LICENSE.TXT for details.
8 ##===----------------------------------------------------------------------===##
10 # A script designed to interpose between the build system and gcc. It invokes
11 # both gcc and the static analyzer.
13 ##===----------------------------------------------------------------------===##
18 use Cwd qw/ getcwd abs_path /;
19 use File::Temp qw/ tempfile /;
20 use File::Path qw / mkpath /;
24 ##===----------------------------------------------------------------------===##
25 # Compiler command setup.
26 ##===----------------------------------------------------------------------===##
31 my $DefaultCXXCompiler;
33 if (`uname -a` =~ m/Darwin/) {
34 $DefaultCCompiler = 'clang';
35 $DefaultCXXCompiler = 'clang++';
37 $DefaultCCompiler = 'gcc';
38 $DefaultCXXCompiler = 'g++';
41 if ($FindBin::Script =~ /c\+\+-analyzer/) {
42 $Compiler = $ENV{'CCC_CXX'};
43 if (!defined $Compiler) { $Compiler = $DefaultCXXCompiler; }
45 $Clang = $ENV{'CLANG_CXX'};
46 if (!defined $Clang) { $Clang = 'clang++'; }
49 $Compiler = $ENV{'CCC_CC'};
50 if (!defined $Compiler) { $Compiler = $DefaultCCompiler; }
52 $Clang = $ENV{'CLANG'};
53 if (!defined $Clang) { $Clang = 'clang'; }
56 ##===----------------------------------------------------------------------===##
58 ##===----------------------------------------------------------------------===##
60 my $ReportFailures = $ENV{'CCC_REPORT_FAILURES'};
61 if (!defined $ReportFailures) { $ReportFailures = 1; }
66 # Remove any stale files at exit.
68 if (defined $ResultFile && -z $ResultFile) {
71 if (defined $CleanupFile) {
76 ##----------------------------------------------------------------------------##
77 # Process Clang Crashes.
78 ##----------------------------------------------------------------------------##
82 if ($Lang =~ /objective-c\+\+/) { return ".mii" };
83 if ($Lang =~ /objective-c/) { return ".mi"; }
84 if ($Lang =~ /c\+\+/) { return ".ii"; }
88 # Set this to 1 if we want to include 'parser rejects' files.
89 my $IncludeParserRejects = 0;
90 my $ParserRejects = "Parser Rejects";
91 my $AttributeIgnored = "Attribute Ignored";
92 my $OtherError = "Other Error";
94 sub ProcessClangFailure {
95 my ($Clang, $Lang, $file, $Args, $HtmlDir, $ErrorType, $ofile) = @_;
96 my $Dir = "$HtmlDir/failures";
99 my $prefix = "clang_crash";
100 if ($ErrorType eq $ParserRejects) {
101 $prefix = "clang_parser_rejects";
103 elsif ($ErrorType eq $AttributeIgnored) {
104 $prefix = "clang_attribute_ignored";
106 elsif ($ErrorType eq $OtherError) {
107 $prefix = "clang_other_error";
110 # Generate the preprocessed file with Clang.
111 my ($PPH, $PPFile) = tempfile( $prefix . "_XXXXXX",
112 SUFFIX => GetPPExt($Lang),
114 system $Clang, @$Args, "-E", "-o", $PPFile;
117 # Create the info file.
118 open (OUT, ">", "$PPFile.info.txt") or die "Cannot open $PPFile.info.txt\n";
119 print OUT abs_path($file), "\n";
120 print OUT "$ErrorType\n";
121 print OUT "@$Args\n";
123 `uname -a >> $PPFile.info.txt 2>&1`;
124 `$Compiler -v >> $PPFile.info.txt 2>&1`;
125 system 'mv',$ofile,"$PPFile.stderr.txt";
126 return (basename $PPFile);
129 ##----------------------------------------------------------------------------##
130 # Running the analyzer.
131 ##----------------------------------------------------------------------------##
137 pipe (FROM_CHILD, TO_PARENT);
141 open(STDOUT,">&", \*TO_PARENT);
142 open(STDERR,">&", \*TO_PARENT);
143 exec $Clang, "-###", $mode, @$Args;
147 while (<FROM_CHILD>) {
155 die "could not find clang line\n" if (!defined $line);
156 # Strip the newline and initial whitspace
159 my @items = quotewords('\s+', 0, $line);
160 my $cmd = shift @items;
161 die "cannot find 'clang' in 'clang' command\n" if (!($cmd =~ /clang/));
166 my ($Clang, $OriginalArgs, $AnalyzeArgs, $Lang, $Output, $Verbose, $HtmlDir,
169 my @Args = @$OriginalArgs;
172 my @CmdArgsSansAnalyses;
174 if ($Lang =~ /header/) {
175 exit 0 if (!defined ($Output));
177 push @CmdArgs, $file;
178 # Remove the PCH extension.
179 $Output =~ s/[.]gch$//;
180 push @CmdArgs, $Output;
181 @CmdArgsSansAnalyses = @CmdArgs;
186 # Create arguments for doing regular parsing.
187 my $SyntaxArgs = GetCCArgs("-fsyntax-only", \@Args);
188 @CmdArgsSansAnalyses = @$SyntaxArgs;
190 # Create arguments for doing static analysis.
191 if (defined $ResultFile) {
192 push @Args, '-o', $ResultFile;
194 elsif (defined $HtmlDir) {
195 push @Args, '-o', $HtmlDir;
198 push @Args, "-Xclang", "-analyzer-display-progress";
201 foreach my $arg (@$AnalyzeArgs) {
202 push @Args, "-Xclang", $arg;
205 # Display Ubiviz graph?
206 if (defined $ENV{'CCC_UBI'}) {
207 push @Args, "-Xclang", "-analyzer-viz-egraph-ubigraph";
210 my $AnalysisArgs = GetCCArgs("--analyze", \@Args);
211 @CmdArgs = @$AnalysisArgs;
219 print STDERR "\n[LOCATION]: $dir\n";
220 push @PrintArgs,"'$Cmd'";
221 foreach my $arg (@CmdArgs) {
222 push @PrintArgs,"\'$arg\'";
226 # We MUST print to stderr. Some clients use the stdout output of
227 # gcc for various purposes.
228 print STDERR join(' ', @PrintArgs);
231 elsif ($Verbose == 2) {
232 print STDERR "#SHELL (cd '$dir' && @PrintArgs)\n";
235 # Capture the STDERR of clang and send it to a temporary file.
236 # Capture the STDOUT of clang and reroute it to ccc-analyzer's STDERR.
237 # We save the output file in the 'crashes' directory if clang encounters
238 # any problems with the file.
239 pipe (FROM_CHILD, TO_PARENT);
243 open(STDOUT,">&", \*TO_PARENT);
244 open(STDERR,">&", \*TO_PARENT);
249 my ($ofh, $ofile) = tempfile("clang_output_XXXXXX", DIR => $HtmlDir);
251 while (<FROM_CHILD>) {
261 # Did the command die because of a signal?
262 if ($ReportFailures) {
263 if ($Result & 127 and $Cmd eq $Clang and defined $HtmlDir) {
264 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses,
265 $HtmlDir, "Crash", $ofile);
268 if ($IncludeParserRejects && !($file =~/conftest/)) {
269 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses,
270 $HtmlDir, $ParserRejects, $ofile);
272 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses,
273 $HtmlDir, $OtherError, $ofile);
277 # Check if there were any unhandled attributes.
278 if (open(CHILD, $ofile)) {
279 my %attributes_not_handled;
281 # Don't flag warnings about the following attributes that we
282 # know are currently not supported by Clang.
283 $attributes_not_handled{"cdecl"} = 1;
287 next if (! /warning: '([^\']+)' attribute ignored/);
289 # Have we already spotted this unhandled attribute?
290 next if (defined $attributes_not_handled{$1});
291 $attributes_not_handled{$1} = 1;
293 # Get the name of the attribute file.
294 my $dir = "$HtmlDir/failures";
295 my $afile = "$dir/attribute_ignored_$1.txt";
297 # Only create another preprocessed file if the attribute file
301 # Add this file to the list of files that contained this attribute.
302 # Generate a preprocessed file if we haven't already.
303 if (!(defined $ppfile)) {
304 $ppfile = ProcessClangFailure($Clang, $Lang, $file,
305 \@CmdArgsSansAnalyses,
306 $HtmlDir, $AttributeIgnored, $ofile);
310 open(AFILE, ">$afile");
311 print AFILE "$ppfile\n";
322 ##----------------------------------------------------------------------------##
324 ##----------------------------------------------------------------------------##
326 my %CompileOptionMap = (
335 '-iwithprefixbefore' => 1
338 my %LinkerOptionMap = (
340 '-fobjc-link-runtime' => 0
343 my %CompilerLinkerOptionMap = (
344 '-Wwrite-strings' => 0,
345 '-ftrapv-handler' => 1, # specifically call out separated -f flag
346 '-mios-simulator-version-min' => 0, # This really has 1 argument, but always has '='
351 '-stdlib' => 0, # This is really a 1 argument, but always has '='
354 '-mmacosx-version-min' => 0, # This is really a 1 argument, but always has '='
355 '-miphoneos-version-min' => 0 # This is really a 1 argument, but always has '='
358 my %IgnoredOptionMap = (
359 '-MT' => 1, # Ignore these preprocessor options.
362 '-fsyntax-only' => 0,
364 '-install_name' => 1,
365 '-exported_symbols_list' => 1,
366 '-current_version' => 1,
367 '-compatibility_version' => 1,
371 '-bundle_loader' => 1,
372 '-multiply_defined' => 1,
376 '--serialize-diagnostics' => 1
388 'i' => 'c-cpp-output',
389 'm' => 'objective-c',
390 'mi' => 'objective-c-cpp-output',
391 'mm' => 'objective-c++'
394 my %UniqueOptions = (
398 ##----------------------------------------------------------------------------##
399 # Languages accepted.
400 ##----------------------------------------------------------------------------##
402 my %LangsAccepted = (
409 ##----------------------------------------------------------------------------##
411 ##----------------------------------------------------------------------------##
421 # Forward arguments to gcc.
422 my $Status = system($Compiler,@ARGV);
423 if (defined $ENV{'CCC_ANALYZER_LOG'}) {
424 print STDERR "$Compiler @ARGV\n";
426 if ($Status) { exit($Status >> 8); }
428 # Get the analysis options.
429 my $Analyses = $ENV{'CCC_ANALYZER_ANALYSIS'};
431 # Get the plugins to load.
432 my $Plugins = $ENV{'CCC_ANALYZER_PLUGINS'};
434 # Get the store model.
435 my $StoreModel = $ENV{'CCC_ANALYZER_STORE_MODEL'};
437 # Get the constraints engine.
438 my $ConstraintsModel = $ENV{'CCC_ANALYZER_CONSTRAINTS_MODEL'};
440 #Get the internal stats setting.
441 my $InternalStats = $ENV{'CCC_ANALYZER_INTERNAL_STATS'};
443 # Get the output format.
444 my $OutputFormat = $ENV{'CCC_ANALYZER_OUTPUT_FORMAT'};
445 if (!defined $OutputFormat) { $OutputFormat = "html"; }
447 # Determine the level of verbosity.
449 if (defined $ENV{'CCC_ANALYZER_VERBOSE'}) { $Verbose = 1; }
450 if (defined $ENV{'CCC_ANALYZER_LOG'}) { $Verbose = 2; }
452 # Get the HTML output directory.
453 my $HtmlDir = $ENV{'CCC_ANALYZER_HTML'};
455 my %DisabledArchs = ('ppc' => 1, 'ppc64' => 1);
459 # Process the arguments.
460 foreach (my $i = 0; $i < scalar(@ARGV); ++$i) {
462 my ($ArgKey) = split /=/,$Arg,2;
464 # Modes ccc-analyzer supports
465 if ($Arg =~ /^-(E|MM?)$/) { $Action = 'preprocess'; }
466 elsif ($Arg eq '-c') { $Action = 'compile'; }
467 elsif ($Arg =~ /^-print-prog-name/) { exit 0; }
469 # Specially handle duplicate cases of -arch
470 if ($Arg eq "-arch") {
471 my $arch = $ARGV[$i+1];
472 # We don't want to process 'ppc' because of Clang's lack of support
473 # for Altivec (also some #defines won't likely be defined correctly, etc.)
474 if (!(defined $DisabledArchs{$arch})) { $ArchsSeen{$arch} = 1; }
480 # Options with possible arguments that should pass through to compiler.
481 if (defined $CompileOptionMap{$ArgKey}) {
482 my $Cnt = $CompileOptionMap{$ArgKey};
483 push @CompileOpts,$Arg;
484 while ($Cnt > 0) { ++$i; --$Cnt; push @CompileOpts, $ARGV[$i]; }
487 # Handle the case where there isn't a space after -iquote
488 if ($Arg =~ /-iquote.*/) {
489 push @CompileOpts,$Arg;
493 # Options with possible arguments that should pass through to linker.
494 if (defined $LinkerOptionMap{$ArgKey}) {
495 my $Cnt = $LinkerOptionMap{$ArgKey};
497 while ($Cnt > 0) { ++$i; --$Cnt; push @LinkOpts, $ARGV[$i]; }
501 # Options with possible arguments that should pass through to both compiler
503 if (defined $CompilerLinkerOptionMap{$ArgKey}) {
504 my $Cnt = $CompilerLinkerOptionMap{$ArgKey};
506 # Check if this is an option that should have a unique value, and if so
507 # determine if the value was checked before.
508 if ($UniqueOptions{$Arg}) {
509 if (defined $Uniqued{$Arg}) {
516 push @CompileOpts,$Arg;
521 push @CompileOpts, $ARGV[$i];
522 push @LinkOpts, $ARGV[$i];
528 if (defined $IgnoredOptionMap{$ArgKey}) {
529 my $Cnt = $IgnoredOptionMap{$ArgKey};
536 # Compile mode flags.
537 if ($Arg =~ /^-[D,I,U](.*)$/) {
540 # FIXME: Check if we are going off the end.
542 $Tmp = $Arg . $ARGV[$i];
544 push @CompileOpts,$Tmp;
548 if ($Arg =~ /-m.*/) {
549 push @CompileOpts,$Arg;
567 if ($Arg =~ /^-[l,L,O]/) {
568 if ($Arg eq '-O') { push @LinkOpts,'-O1'; }
569 elsif ($Arg eq '-Os') { push @LinkOpts,'-O2'; }
570 else { push @LinkOpts,$Arg; }
572 # Must pass this along for the __OPTIMIZE__ macro
573 if ($Arg =~ /^-O/) { push @CompileOpts,$Arg; }
577 if ($Arg =~ /^-std=/) {
578 push @CompileOpts,$Arg;
582 # Get the compiler/link mode.
583 if ($Arg =~ /^-F(.+)$/) {
586 # FIXME: Check if we are going off the end.
588 $Tmp = $Arg . $ARGV[$i];
590 push @CompileOpts,$Tmp;
596 if ($Arg eq '-filelist') {
597 # FIXME: Make sure we aren't walking off the end.
598 open(IN, $ARGV[$i+1]);
599 while (<IN>) { s/\015?\012//; push @Files,$_; }
606 push @CompileOpts,$Arg;
611 # Handle -Wno-. We don't care about extra warnings, but
612 # we should suppress ones that we don't want to see.
613 if ($Arg =~ /^-Wno-/) {
614 push @CompileOpts, $Arg;
618 if (!($Arg =~ /^-/)) {
624 if ($Action eq 'compile' or $Action eq 'link') {
625 my @Archs = keys %ArchsSeen;
626 # Skip the file if we don't support the architectures specified.
627 exit 0 if ($HadArch && scalar(@Archs) == 0);
629 foreach my $file (@Files) {
630 # Determine the language for the file.
631 my $FileLang = $Lang;
633 if (!defined($FileLang)) {
634 # Infer the language from the extension.
635 if ($file =~ /[.]([^.]+)$/) {
636 $FileLang = $LangMap{$1};
640 # FileLang still not defined? Skip the file.
641 next if (!defined $FileLang);
643 # Language not accepted?
644 next if (!defined $LangsAccepted{$FileLang});
649 if ($FileLang ne 'unknown') {
650 push @CmdArgs, '-x', $FileLang;
653 if (defined $StoreModel) {
654 push @AnalyzeArgs, "-analyzer-store=$StoreModel";
657 if (defined $ConstraintsModel) {
658 push @AnalyzeArgs, "-analyzer-constraints=$ConstraintsModel";
661 if (defined $InternalStats) {
662 push @AnalyzeArgs, "-analyzer-stats";
665 if (defined $Analyses) {
666 push @AnalyzeArgs, split '\s+', $Analyses;
669 if (defined $Plugins) {
670 push @AnalyzeArgs, split '\s+', $Plugins;
673 if (defined $OutputFormat) {
674 push @AnalyzeArgs, "-analyzer-output=" . $OutputFormat;
675 if ($OutputFormat =~ /plist/) {
676 # Change "Output" to be a file.
677 my ($h, $f) = tempfile("report-XXXXXX", SUFFIX => ".plist",
680 # If the HtmlDir is not set, we sould clean up the plist files.
681 if (!defined $HtmlDir || -z $HtmlDir) {
687 push @CmdArgs, @CompileOpts;
688 push @CmdArgs, $file;
691 foreach my $arch (@Archs) {
693 push @NewArgs, '-arch', $arch;
694 push @NewArgs, @CmdArgs;
695 Analyze($Clang, \@NewArgs, \@AnalyzeArgs, $FileLang, $Output,
696 $Verbose, $HtmlDir, $file);
700 Analyze($Clang, \@CmdArgs, \@AnalyzeArgs, $FileLang, $Output,
701 $Verbose, $HtmlDir, $file);