ccc-analyzer revision 1a45a5ff5d495cb6cd9a3d4d06317af79c0f634d
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 interpose between the build system and gcc. It invokes 11# both gcc and the static analyzer. 12# 13##===----------------------------------------------------------------------===## 14 15use strict; 16use warnings; 17use FindBin; 18use Cwd qw/ getcwd abs_path /; 19use File::Temp qw/ tempfile /; 20use File::Path qw / mkpath /; 21use File::Basename; 22use Text::ParseWords; 23 24##===----------------------------------------------------------------------===## 25# Compiler command setup. 26##===----------------------------------------------------------------------===## 27 28my $Compiler; 29my $Clang; 30my $DefaultCCompiler; 31my $DefaultCXXCompiler; 32 33if (`uname -a` =~ m/Darwin/) { 34 $DefaultCCompiler = 'clang'; 35 $DefaultCXXCompiler = 'clang++'; 36} else { 37 $DefaultCCompiler = 'gcc'; 38 $DefaultCXXCompiler = 'g++'; 39} 40 41if ($FindBin::Script =~ /c\+\+-analyzer/) { 42 $Compiler = $ENV{'CCC_CXX'}; 43 if (!defined $Compiler) { $Compiler = $DefaultCXXCompiler; } 44 45 $Clang = $ENV{'CLANG_CXX'}; 46 if (!defined $Clang) { $Clang = 'clang++'; } 47} 48else { 49 $Compiler = $ENV{'CCC_CC'}; 50 if (!defined $Compiler) { $Compiler = $DefaultCCompiler; } 51 52 $Clang = $ENV{'CLANG'}; 53 if (!defined $Clang) { $Clang = 'clang'; } 54} 55 56##===----------------------------------------------------------------------===## 57# Cleanup. 58##===----------------------------------------------------------------------===## 59 60my $ReportFailures = $ENV{'CCC_REPORT_FAILURES'}; 61if (!defined $ReportFailures) { $ReportFailures = 1; } 62 63my $CleanupFile; 64my $ResultFile; 65 66# Remove any stale files at exit. 67END { 68 if (defined $ResultFile && -z $ResultFile) { 69 `rm -f $ResultFile`; 70 } 71 if (defined $CleanupFile) { 72 `rm -f $CleanupFile`; 73 } 74} 75 76##----------------------------------------------------------------------------## 77# Process Clang Crashes. 78##----------------------------------------------------------------------------## 79 80sub GetPPExt { 81 my $Lang = shift; 82 if ($Lang =~ /objective-c\+\+/) { return ".mii" }; 83 if ($Lang =~ /objective-c/) { return ".mi"; } 84 if ($Lang =~ /c\+\+/) { return ".ii"; } 85 return ".i"; 86} 87 88# Set this to 1 if we want to include 'parser rejects' files. 89my $IncludeParserRejects = 0; 90my $ParserRejects = "Parser Rejects"; 91my $AttributeIgnored = "Attribute Ignored"; 92my $OtherError = "Other Error"; 93 94sub ProcessClangFailure { 95 my ($Clang, $Lang, $file, $Args, $HtmlDir, $ErrorType, $ofile) = @_; 96 my $Dir = "$HtmlDir/failures"; 97 mkpath $Dir; 98 99 my $prefix = "clang_crash"; 100 if ($ErrorType eq $ParserRejects) { 101 $prefix = "clang_parser_rejects"; 102 } 103 elsif ($ErrorType eq $AttributeIgnored) { 104 $prefix = "clang_attribute_ignored"; 105 } 106 elsif ($ErrorType eq $OtherError) { 107 $prefix = "clang_other_error"; 108 } 109 110 # Generate the preprocessed file with Clang. 111 my ($PPH, $PPFile) = tempfile( $prefix . "_XXXXXX", 112 SUFFIX => GetPPExt($Lang), 113 DIR => $Dir); 114 system $Clang, @$Args, "-E", "-o", $PPFile; 115 close ($PPH); 116 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"; 122 close OUT; 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); 127} 128 129##----------------------------------------------------------------------------## 130# Running the analyzer. 131##----------------------------------------------------------------------------## 132 133sub GetCCArgs { 134 my $mode = shift; 135 my $Args = shift; 136 137 pipe (FROM_CHILD, TO_PARENT); 138 my $pid = fork(); 139 if ($pid == 0) { 140 close FROM_CHILD; 141 open(STDOUT,">&", \*TO_PARENT); 142 open(STDERR,">&", \*TO_PARENT); 143 exec $Clang, "-###", $mode, @$Args; 144 } 145 close(TO_PARENT); 146 my $line; 147 while (<FROM_CHILD>) { 148 next if (!/-cc1/); 149 $line = $_; 150 } 151 152 waitpid($pid,0); 153 close(FROM_CHILD); 154 155 die "could not find clang line\n" if (!defined $line); 156 # Strip the newline and initial whitspace 157 chomp $line; 158 $line =~ s/^\s+//; 159 my @items = quotewords('\s+', 0, $line); 160 my $cmd = shift @items; 161 die "cannot find 'clang' in 'clang' command\n" if (!($cmd =~ /clang/)); 162 return \@items; 163} 164 165sub Analyze { 166 my ($Clang, $OriginalArgs, $AnalyzeArgs, $Lang, $Output, $Verbose, $HtmlDir, 167 $file) = @_; 168 169 my @Args = @$OriginalArgs; 170 my $Cmd; 171 my @CmdArgs; 172 my @CmdArgsSansAnalyses; 173 174 if ($Lang =~ /header/) { 175 exit 0 if (!defined ($Output)); 176 $Cmd = 'cp'; 177 push @CmdArgs, $file; 178 # Remove the PCH extension. 179 $Output =~ s/[.]gch$//; 180 push @CmdArgs, $Output; 181 @CmdArgsSansAnalyses = @CmdArgs; 182 } 183 else { 184 $Cmd = $Clang; 185 if ($Lang eq "objective-c" || $Lang eq "objective-c++") { 186 push @Args,'-DIBOutlet=__attribute__((iboutlet))'; 187 push @Args,'-DIBOutletCollection(ClassName)=__attribute__((iboutletcollection)))'; 188 push @Args,'-DIBAction=void)__attribute__((ibaction)'; 189 } 190 191 # Create arguments for doing regular parsing. 192 my $SyntaxArgs = GetCCArgs("-fsyntax-only", \@Args); 193 @CmdArgsSansAnalyses = @$SyntaxArgs; 194 195 # Create arguments for doing static analysis. 196 if (defined $ResultFile) { 197 push @Args, '-o', $ResultFile; 198 } 199 elsif (defined $HtmlDir) { 200 push @Args, '-o', $HtmlDir; 201 } 202 if ($Verbose) { 203 push @Args, "-Xclang", "-analyzer-display-progress"; 204 } 205 206 foreach my $arg (@$AnalyzeArgs) { 207 push @Args, "-Xclang", $arg; 208 } 209 210 # Display Ubiviz graph? 211 if (defined $ENV{'CCC_UBI'}) { 212 push @Args, "-Xclang", "-analyzer-viz-egraph-ubigraph"; 213 } 214 215 my $AnalysisArgs = GetCCArgs("--analyze", \@Args); 216 @CmdArgs = @$AnalysisArgs; 217 } 218 219 my @PrintArgs; 220 my $dir; 221 222 if ($Verbose) { 223 $dir = getcwd(); 224 print STDERR "\n[LOCATION]: $dir\n"; 225 push @PrintArgs,"'$Cmd'"; 226 foreach my $arg (@CmdArgs) { 227 push @PrintArgs,"\'$arg\'"; 228 } 229 } 230 if ($Verbose == 1) { 231 # We MUST print to stderr. Some clients use the stdout output of 232 # gcc for various purposes. 233 print STDERR join(' ', @PrintArgs); 234 print STDERR "\n"; 235 } 236 elsif ($Verbose == 2) { 237 print STDERR "#SHELL (cd '$dir' && @PrintArgs)\n"; 238 } 239 240 # Capture the STDERR of clang and send it to a temporary file. 241 # Capture the STDOUT of clang and reroute it to ccc-analyzer's STDERR. 242 # We save the output file in the 'crashes' directory if clang encounters 243 # any problems with the file. 244 pipe (FROM_CHILD, TO_PARENT); 245 my $pid = fork(); 246 if ($pid == 0) { 247 close FROM_CHILD; 248 open(STDOUT,">&", \*TO_PARENT); 249 open(STDERR,">&", \*TO_PARENT); 250 exec $Cmd, @CmdArgs; 251 } 252 253 close TO_PARENT; 254 my ($ofh, $ofile) = tempfile("clang_output_XXXXXX", DIR => $HtmlDir); 255 256 while (<FROM_CHILD>) { 257 print $ofh $_; 258 print STDERR $_; 259 } 260 261 waitpid($pid,0); 262 close(FROM_CHILD); 263 my $Result = $?; 264 265 # Did the command die because of a signal? 266 if ($ReportFailures) { 267 if ($Result & 127 and $Cmd eq $Clang and defined $HtmlDir) { 268 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, 269 $HtmlDir, "Crash", $ofile); 270 } 271 elsif ($Result) { 272 if ($IncludeParserRejects && !($file =~/conftest/)) { 273 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, 274 $HtmlDir, $ParserRejects, $ofile); 275 } else { 276 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, 277 $HtmlDir, $OtherError, $ofile); 278 } 279 } 280 else { 281 # Check if there were any unhandled attributes. 282 if (open(CHILD, $ofile)) { 283 my %attributes_not_handled; 284 285 # Don't flag warnings about the following attributes that we 286 # know are currently not supported by Clang. 287 $attributes_not_handled{"cdecl"} = 1; 288 289 my $ppfile; 290 while (<CHILD>) { 291 next if (! /warning: '([^\']+)' attribute ignored/); 292 293 # Have we already spotted this unhandled attribute? 294 next if (defined $attributes_not_handled{$1}); 295 $attributes_not_handled{$1} = 1; 296 297 # Get the name of the attribute file. 298 my $dir = "$HtmlDir/failures"; 299 my $afile = "$dir/attribute_ignored_$1.txt"; 300 301 # Only create another preprocessed file if the attribute file 302 # doesn't exist yet. 303 next if (-e $afile); 304 305 # Add this file to the list of files that contained this attribute. 306 # Generate a preprocessed file if we haven't already. 307 if (!(defined $ppfile)) { 308 $ppfile = ProcessClangFailure($Clang, $Lang, $file, 309 \@CmdArgsSansAnalyses, 310 $HtmlDir, $AttributeIgnored, $ofile); 311 } 312 313 mkpath $dir; 314 open(AFILE, ">$afile"); 315 print AFILE "$ppfile\n"; 316 close(AFILE); 317 } 318 close CHILD; 319 } 320 } 321 } 322 323 unlink($ofile); 324} 325 326##----------------------------------------------------------------------------## 327# Lookup tables. 328##----------------------------------------------------------------------------## 329 330my %CompileOptionMap = ( 331 '-nostdinc' => 0, 332 '-fblocks' => 0, 333 '-fno-builtin' => 0, 334 '-fobjc-gc-only' => 0, 335 '-fobjc-gc' => 0, 336 '-ffreestanding' => 0, 337 '-include' => 1, 338 '-idirafter' => 1, 339 '-imacros' => 1, 340 '-iprefix' => 1, 341 '-iquote' => 1, 342 '-isystem' => 1, 343 '-iwithprefix' => 1, 344 '-iwithprefixbefore' => 1 345); 346 347my %LinkerOptionMap = ( 348 '-framework' => 1, 349 '-fobjc-link-runtime' => 0 350); 351 352my %CompilerLinkerOptionMap = ( 353 '-fobjc-arc' => 0, 354 '-fobjc-abi-version' => 0, # This is really a 1 argument, but always has '=' 355 '-isysroot' => 1, 356 '-arch' => 1, 357 '-m32' => 0, 358 '-m64' => 0, 359 '-v' => 0, 360 '-fpascal-strings' => 0, 361 '-mmacosx-version-min' => 0, # This is really a 1 argument, but always has '=' 362 '-miphoneos-version-min' => 0 # This is really a 1 argument, but always has '=' 363); 364 365my %IgnoredOptionMap = ( 366 '-MT' => 1, # Ignore these preprocessor options. 367 '-MF' => 1, 368 369 '-fsyntax-only' => 0, 370 '-save-temps' => 0, 371 '-install_name' => 1, 372 '-exported_symbols_list' => 1, 373 '-current_version' => 1, 374 '-compatibility_version' => 1, 375 '-init' => 1, 376 '-e' => 1, 377 '-seg1addr' => 1, 378 '-bundle_loader' => 1, 379 '-multiply_defined' => 1, 380 '-sectorder' => 3, 381 '--param' => 1, 382 '-u' => 1, 383 '--serialize-diagnostics' => 1 384); 385 386my %LangMap = ( 387 'c' => 'c', 388 'cp' => 'c++', 389 'cpp' => 'c++', 390 'cc' => 'c++', 391 'ii' => 'c++', 392 'i' => 'c-cpp-output', 393 'm' => 'objective-c', 394 'mi' => 'objective-c-cpp-output', 395 'mm' => 'objective-c++' 396); 397 398my %UniqueOptions = ( 399 '-isysroot' => 0 400); 401 402##----------------------------------------------------------------------------## 403# Languages accepted. 404##----------------------------------------------------------------------------## 405 406my %LangsAccepted = ( 407 "objective-c" => 1, 408 "c" => 1, 409 "c++" => 1, 410 "objective-c++" => 1 411); 412 413##----------------------------------------------------------------------------## 414# Main Logic. 415##----------------------------------------------------------------------------## 416 417my $Action = 'link'; 418my @CompileOpts; 419my @LinkOpts; 420my @Files; 421my $Lang; 422my $Output; 423my %Uniqued; 424 425# Forward arguments to gcc. 426my $Status = system($Compiler,@ARGV); 427if (defined $ENV{'CCC_ANALYZER_LOG'}) { 428 print "$Compiler @ARGV\n"; 429} 430if ($Status) { exit($Status >> 8); } 431 432# Get the analysis options. 433my $Analyses = $ENV{'CCC_ANALYZER_ANALYSIS'}; 434 435# Get the store model. 436my $StoreModel = $ENV{'CCC_ANALYZER_STORE_MODEL'}; 437 438# Get the constraints engine. 439my $ConstraintsModel = $ENV{'CCC_ANALYZER_CONSTRAINTS_MODEL'}; 440 441# Get the output format. 442my $OutputFormat = $ENV{'CCC_ANALYZER_OUTPUT_FORMAT'}; 443if (!defined $OutputFormat) { $OutputFormat = "html"; } 444 445# Determine the level of verbosity. 446my $Verbose = 0; 447if (defined $ENV{CCC_ANALYZER_VERBOSE}) { $Verbose = 1; } 448if (defined $ENV{CCC_ANALYZER_LOG}) { $Verbose = 2; } 449 450# Get the HTML output directory. 451my $HtmlDir = $ENV{'CCC_ANALYZER_HTML'}; 452 453my %DisabledArchs = ('ppc' => 1, 'ppc64' => 1); 454my %ArchsSeen; 455my $HadArch = 0; 456 457# Process the arguments. 458foreach (my $i = 0; $i < scalar(@ARGV); ++$i) { 459 my $Arg = $ARGV[$i]; 460 my ($ArgKey) = split /=/,$Arg,2; 461 462 # Modes ccc-analyzer supports 463 if ($Arg =~ /^-(E|MM?)$/) { $Action = 'preprocess'; } 464 elsif ($Arg eq '-c') { $Action = 'compile'; } 465 elsif ($Arg =~ /^-print-prog-name/) { exit 0; } 466 467 # Specially handle duplicate cases of -arch 468 if ($Arg eq "-arch") { 469 my $arch = $ARGV[$i+1]; 470 # We don't want to process 'ppc' because of Clang's lack of support 471 # for Altivec (also some #defines won't likely be defined correctly, etc.) 472 if (!(defined $DisabledArchs{$arch})) { $ArchsSeen{$arch} = 1; } 473 $HadArch = 1; 474 ++$i; 475 next; 476 } 477 478 # Options with possible arguments that should pass through to compiler. 479 if (defined $CompileOptionMap{$ArgKey}) { 480 my $Cnt = $CompileOptionMap{$ArgKey}; 481 push @CompileOpts,$Arg; 482 while ($Cnt > 0) { ++$i; --$Cnt; push @CompileOpts, $ARGV[$i]; } 483 next; 484 } 485 486 # Options with possible arguments that should pass through to linker. 487 if (defined $LinkerOptionMap{$ArgKey}) { 488 my $Cnt = $LinkerOptionMap{$ArgKey}; 489 push @LinkOpts,$Arg; 490 while ($Cnt > 0) { ++$i; --$Cnt; push @LinkOpts, $ARGV[$i]; } 491 next; 492 } 493 494 # Options with possible arguments that should pass through to both compiler 495 # and the linker. 496 if (defined $CompilerLinkerOptionMap{$ArgKey}) { 497 my $Cnt = $CompilerLinkerOptionMap{$ArgKey}; 498 499 # Check if this is an option that should have a unique value, and if so 500 # determine if the value was checked before. 501 if ($UniqueOptions{$Arg}) { 502 if (defined $Uniqued{$Arg}) { 503 $i += $Cnt; 504 next; 505 } 506 $Uniqued{$Arg} = 1; 507 } 508 509 push @CompileOpts,$Arg; 510 push @LinkOpts,$Arg; 511 512 while ($Cnt > 0) { 513 ++$i; --$Cnt; 514 push @CompileOpts, $ARGV[$i]; 515 push @LinkOpts, $ARGV[$i]; 516 } 517 next; 518 } 519 520 # Ignored options. 521 if (defined $IgnoredOptionMap{$ArgKey}) { 522 my $Cnt = $IgnoredOptionMap{$ArgKey}; 523 while ($Cnt > 0) { 524 ++$i; --$Cnt; 525 } 526 next; 527 } 528 529 # Compile mode flags. 530 if ($Arg =~ /^-[D,I,U](.*)$/) { 531 my $Tmp = $Arg; 532 if ($1 eq '') { 533 # FIXME: Check if we are going off the end. 534 ++$i; 535 $Tmp = $Arg . $ARGV[$i]; 536 } 537 push @CompileOpts,$Tmp; 538 next; 539 } 540 541 # Language. 542 if ($Arg eq '-x') { 543 $Lang = $ARGV[$i+1]; 544 ++$i; next; 545 } 546 547 # Output file. 548 if ($Arg eq '-o') { 549 ++$i; 550 $Output = $ARGV[$i]; 551 next; 552 } 553 554 # Get the link mode. 555 if ($Arg =~ /^-[l,L,O]/) { 556 if ($Arg eq '-O') { push @LinkOpts,'-O1'; } 557 elsif ($Arg eq '-Os') { push @LinkOpts,'-O2'; } 558 else { push @LinkOpts,$Arg; } 559 next; 560 } 561 562 if ($Arg =~ /^-std=/) { 563 push @CompileOpts,$Arg; 564 next; 565 } 566 567# if ($Arg =~ /^-f/) { 568# # FIXME: Not sure if the remaining -fxxxx options have no arguments. 569# push @CompileOpts,$Arg; 570# push @LinkOpts,$Arg; # FIXME: Not sure if these are link opts. 571# } 572 573 # Get the compiler/link mode. 574 if ($Arg =~ /^-F(.+)$/) { 575 my $Tmp = $Arg; 576 if ($1 eq '') { 577 # FIXME: Check if we are going off the end. 578 ++$i; 579 $Tmp = $Arg . $ARGV[$i]; 580 } 581 push @CompileOpts,$Tmp; 582 push @LinkOpts,$Tmp; 583 next; 584 } 585 586 # Input files. 587 if ($Arg eq '-filelist') { 588 # FIXME: Make sure we aren't walking off the end. 589 open(IN, $ARGV[$i+1]); 590 while (<IN>) { s/\015?\012//; push @Files,$_; } 591 close(IN); 592 ++$i; 593 next; 594 } 595 596 # Handle -Wno-. We don't care about extra warnings, but 597 # we should suppress ones that we don't want to see. 598 if ($Arg =~ /^-Wno-/) { 599 push @CompileOpts, $Arg; 600 next; 601 } 602 603 if (!($Arg =~ /^-/)) { 604 push @Files, $Arg; 605 next; 606 } 607} 608 609if ($Action eq 'compile' or $Action eq 'link') { 610 my @Archs = keys %ArchsSeen; 611 # Skip the file if we don't support the architectures specified. 612 exit 0 if ($HadArch && scalar(@Archs) == 0); 613 614 foreach my $file (@Files) { 615 # Determine the language for the file. 616 my $FileLang = $Lang; 617 618 if (!defined($FileLang)) { 619 # Infer the language from the extension. 620 if ($file =~ /[.]([^.]+)$/) { 621 $FileLang = $LangMap{$1}; 622 } 623 } 624 625 # FileLang still not defined? Skip the file. 626 next if (!defined $FileLang); 627 628 # Language not accepted? 629 next if (!defined $LangsAccepted{$FileLang}); 630 631 my @CmdArgs; 632 my @AnalyzeArgs; 633 634 if ($FileLang ne 'unknown') { 635 push @CmdArgs, '-x', $FileLang; 636 } 637 638 if (defined $StoreModel) { 639 push @AnalyzeArgs, "-analyzer-store=$StoreModel"; 640 } 641 642 if (defined $ConstraintsModel) { 643 push @AnalyzeArgs, "-analyzer-constraints=$ConstraintsModel"; 644 } 645 646 if (defined $Analyses) { 647 push @AnalyzeArgs, split '\s+', $Analyses; 648 } 649 650 if (defined $OutputFormat) { 651 push @AnalyzeArgs, "-analyzer-output=" . $OutputFormat; 652 if ($OutputFormat =~ /plist/) { 653 # Change "Output" to be a file. 654 my ($h, $f) = tempfile("report-XXXXXX", SUFFIX => ".plist", 655 DIR => $HtmlDir); 656 $ResultFile = $f; 657 # If the HtmlDir is not set, we sould clean up the plist files. 658 if (!defined $HtmlDir || -z $HtmlDir) { 659 $CleanupFile = $f; 660 } 661 } 662 } 663 664 push @CmdArgs, @CompileOpts; 665 push @CmdArgs, $file; 666 667 if (scalar @Archs) { 668 foreach my $arch (@Archs) { 669 my @NewArgs; 670 push @NewArgs, '-arch', $arch; 671 push @NewArgs, @CmdArgs; 672 Analyze($Clang, \@NewArgs, \@AnalyzeArgs, $FileLang, $Output, 673 $Verbose, $HtmlDir, $file); 674 } 675 } 676 else { 677 Analyze($Clang, \@CmdArgs, \@AnalyzeArgs, $FileLang, $Output, 678 $Verbose, $HtmlDir, $file); 679 } 680 } 681} 682 683exit($Status >> 8); 684 685